Members
(static) InclusionMode :number
The 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.
Properties:
| Name | Type | Description |
|---|---|---|
INCLUSION_MODE_UNSPECIFIED |
number |
Unspecified. Setting the mode with this value will disable inclusion/exclusion filtering for Asset Discovery. |
INCLUDE_ONLY |
number |
Asset Discovery will capture only the resources within the projects specified. All other resources will be ignored. |
EXCLUDE |
number |
Asset Discovery will ignore all resources under the projects specified. All other resources will be retrieved. |
(static) State :number
The state of the finding.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
Unspecified state. |
ACTIVE |
number |
The finding requires attention and has not been addressed yet. |
INACTIVE |
number |
The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active. |
(static) State :number
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 should be: UNUSED
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
Unspecified state. |
UNUSED |
number |
Request did not specify use of this field in the result. |
ADDED |
number |
Asset was added between the points in time. |
REMOVED |
number |
Asset was removed between the points in time. |
ACTIVE |
number |
Asset was active at both point(s) in time. |
Type Definitions
Asset
Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource.
The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". |
securityCenterProperties |
Object |
Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. This object should have the same structure as SecurityCenterProperties |
resourceProperties |
Object.<string, Object> |
Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. |
securityMarks |
Object |
User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. This object should have the same structure as SecurityMarks |
createTime |
Object |
The time at which the asset was created in Cloud SCC. This object should have the same structure as Timestamp |
updateTime |
Object |
The time at which the asset was last updated, added, or deleted in Cloud SCC. This object should have the same structure as Timestamp |
- Source:
- See:
AssetDiscoveryConfig
The configuration used for Asset Discovery runs.
Properties:
| Name | Type | Description |
|---|---|---|
projectIds |
Array.<string> |
The project ids to use for filtering asset discovery. |
inclusionMode |
number |
The mode to use for filtering asset discovery. The number should be among the values of InclusionMode |
- Source:
- See:
CreateFindingRequest
Request message for creating a finding.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". |
findingId |
string |
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. |
finding |
Object |
The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource. This object should have the same structure as Finding |
- Source:
- See:
CreateSourceRequest
Request message for creating a source.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Resource name of the new source's parent. Its format should be "organizations/[organization_id]". |
source |
Object |
The Source being created, only the display_name and description will be used. All other fields will be ignored. This object should have the same structure as Source |
- Source:
- See:
Finding
Cloud Security Command Center (Cloud SCC) finding.
A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" |
parent |
string |
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/123/sources/456" |
resourceName |
string |
The full resource name of the Google Cloud Platform (GCP) resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name This field is immutable after creation time. |
state |
number |
The state of the finding. The number should be among the values of State |
category |
string |
The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" |
externalUri |
string |
The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. |
sourceProperties |
Object.<string, Object> |
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. |
securityMarks |
Object |
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. This object should have the same structure as SecurityMarks |
eventTime |
Object |
The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the open firewall was detected. This object should have the same structure as Timestamp |
createTime |
Object |
The time at which the finding was created in Cloud SCC. This object should have the same structure as Timestamp |
- Source:
- See:
GetOrganizationSettingsRequest
Request message for getting organization settings.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". |
- Source:
- See:
GetSourceRequest
Request message for getting a source.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". |
- Source:
- See:
GroupAssetsRequest
Request message for grouping by assets.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Name of the organization to groupBy. Its format is "organizations/[organization_id]". |
filter |
string |
Expression that defines the filter to apply across assets.
The expression is a list of zero or more restrictions combined via logical
operators Restrictions have the form
The supported operators are:
The supported value types are:
For example, |
groupBy |
string |
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:
The following fields are supported when compare_duration is set:
|
compareDuration |
Object |
When compare_duration is set, the Asset's "state" 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 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" values when compare_duration is specified:
This field is ignored if This object should have the same structure as Duration |
readTime |
Object |
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. This object should have the same structure as Timestamp |
pageToken |
string |
The value returned by the last |
pageSize |
number |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
- Source:
- See:
GroupAssetsResponse
Response message for grouping by assets.
Properties:
| Name | Type | Description |
|---|---|---|
groupByResults |
Array.<Object> |
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. This object should have the same structure as GroupResult |
readTime |
Object |
Time used for executing the groupBy request. This object should have the same structure as Timestamp |
nextPageToken |
string |
Token to retrieve the next page of results, or empty if there are no more results. |
- Source:
- See:
GroupFindingsRequest
Request message for grouping by findings.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Name of the source to groupBy. Its format is
"organizations/[organization_id]/sources/[source_id]". To groupBy across
all sources provide a source_id of |
filter |
string |
Expression that defines the filter to apply across findings.
The expression is a list of one or more restrictions combined via logical
operators Restrictions have the form
The supported operators are:
The supported value types are:
For example, |
groupBy |
string |
Expression that defines what assets fields to use for grouping (including
The following fields are supported:
|
readTime |
Object |
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. This object should have the same structure as Timestamp |
pageToken |
string |
The value returned by the last |
pageSize |
number |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
- Source:
- See:
GroupFindingsResponse
Response message for group by findings.
Properties:
| Name | Type | Description |
|---|---|---|
groupByResults |
Array.<Object> |
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. This object should have the same structure as GroupResult |
readTime |
Object |
Time used for executing the groupBy request. This object should have the same structure as Timestamp |
nextPageToken |
string |
Token to retrieve the next page of results, or empty if there are no more results. |
- Source:
- See:
GroupResult
Result containing the properties and count of a groupBy request.
Properties:
| Name | Type | Description |
|---|---|---|
properties |
Object.<string, Object> |
Properties matching the groupBy fields in the request. |
count |
number |
Total count of resources for the given properties. |
- Source:
- See:
ListAssetsRequest
Request message for listing assets.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Name of the organization assets should belong to. Its format is "organizations/[organization_id]". |
filter |
string |
Expression that defines the filter to apply across assets.
The expression is a list of zero or more restrictions combined via logical
operators Restrictions have the form
The supported operators are:
The supported value types are:
For example, |
orderBy |
string |
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. |
readTime |
Object |
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. This object should have the same structure as Timestamp |
compareDuration |
Object |
When compare_duration is set, the ListAssetResult's "state" 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 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" values when compare_duration is specified:
If compare_duration is not specified, then the only possible state is "UNUSED", which indicates that the asset is present at read_time. This object should have the same structure as Duration |
fieldMask |
Object |
Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. This object should have the same structure as FieldMask |
pageToken |
string |
The value returned by the last |
pageSize |
number |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
- Source:
- See:
ListAssetsResponse
Response message for listing assets.
Properties:
| Name | Type | Description |
|---|---|---|
listAssetsResults |
Array.<Object> |
Assets matching the list request. This object should have the same structure as ListAssetsResult |
readTime |
Object |
Time used for executing the list request. This object should have the same structure as Timestamp |
nextPageToken |
string |
Token to retrieve the next page of results, or empty if there are no more results. |
totalSize |
number |
The total number of assets matching the query. |
- Source:
- See:
ListAssetsResult
Result containing the Asset and its State.
Properties:
| Name | Type | Description |
|---|---|---|
asset |
Object |
Asset matching the search request. This object should have the same structure as Asset |
state |
number |
State of the asset. The number should be among the values of State |
- Source:
- See:
ListFindingsRequest
Request message for listing findings.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Name of the source the findings belong to. Its format is
"organizations/[organization_id]/sources/[source_id]". To list across all
sources provide a source_id of |
filter |
string |
Expression that defines the filter to apply across findings.
The expression is a list of one or more restrictions combined via logical
operators Restrictions have the form
The supported operators are:
The supported value types are:
For example, |
orderBy |
string |
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. |
readTime |
Object |
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. This object should have the same structure as Timestamp |
fieldMask |
Object |
Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. This object should have the same structure as FieldMask |
pageToken |
string |
The value returned by the last |
pageSize |
number |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
- Source:
- See:
ListFindingsResponse
Response message for listing findings.
Properties:
| Name | Type | Description |
|---|---|---|
findings |
Array.<Object> |
Findings matching the list request. This object should have the same structure as Finding |
readTime |
Object |
Time used for executing the list request. This object should have the same structure as Timestamp |
nextPageToken |
string |
Token to retrieve the next page of results, or empty if there are no more results. |
totalSize |
number |
The total number of findings matching the query. |
- Source:
- See:
ListSourcesRequest
Request message for listing sources.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". |
pageToken |
string |
The value returned by the last |
pageSize |
number |
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |
- Source:
- See:
ListSourcesResponse
Response message for listing sources.
Properties:
| Name | Type | Description |
|---|---|---|
sources |
Array.<Object> |
Sources belonging to the requested parent. This object should have the same structure as Source |
nextPageToken |
string |
Token to retrieve the next page of results, or empty if there are no more results. |
- Source:
- See:
OrganizationSettings
User specified settings that are attached to the Cloud Security Command Center (Cloud SCC) organization.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". |
enableAssetDiscovery |
boolean |
A flag that indicates if Asset Discovery should be enabled. If the flag is
set to |
assetDiscoveryConfig |
Object |
The configuration used for Asset Discovery runs. This object should have the same structure as AssetDiscoveryConfig |
- Source:
- See:
RunAssetDiscoveryRequest
Request message for running asset discovery for an organization.
Properties:
| Name | Type | Description |
|---|---|---|
parent |
string |
Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". |
- Source:
- See:
SecurityCenterProperties
Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user.
Properties:
| Name | Type | Description |
|---|---|---|
resourceName |
string |
The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name |
resourceType |
string |
The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. |
resourceParent |
string |
The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name |
resourceProject |
string |
The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name |
resourceOwners |
Array.<string> |
Owners of the Google Cloud resource. |
- Source:
- See:
SecurityMarks
User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". |
marks |
Object.<string, string> |
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 alphanumeric and between 1 - 256 characters (inclusive) - Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) |
- Source:
- See:
SetFindingStateRequest
Request message for updating a finding's state.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". |
state |
number |
The desired State of the finding. The number should be among the values of State |
startTime |
Object |
The time at which the updated state takes effect. This object should have the same structure as Timestamp |
- Source:
- See:
Source
Cloud Security Command Center's (Cloud SCC) 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, etc.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" |
displayName |
string |
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 start and end with a letter or digit, may contain
letters, digits, spaces, hyphens, and underscores, and can be no longer
than 32 characters. This is captured by the regular expression:
|
description |
string |
The description of the source (max of 1024 characters). Example: "Cloud 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/insecure libraries." |
- Source:
- See:
UpdateFindingRequest
Request message for updating or creating a finding.
Properties:
| Name | Type | Description |
|---|---|---|
finding |
Object |
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 alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. This object should have the same structure as Finding |
updateMask |
Object |
The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. This object should have the same structure as FieldMask |
- Source:
- See:
UpdateOrganizationSettingsRequest
Request message for updating an organization's settings.
Properties:
| Name | Type | Description |
|---|---|---|
organizationSettings |
Object |
The organization settings resource to update. This object should have the same structure as OrganizationSettings |
updateMask |
Object |
The FieldMask to use when updating the settings resource. This object should have the same structure as FieldMask |
- Source:
- See:
UpdateSecurityMarksRequest
Request message for updating a SecurityMarks resource.
Properties:
| Name | Type | Description |
|---|---|---|
securityMarks |
Object |
The security marks resource to update. This object should have the same structure as SecurityMarks |
updateMask |
Object |
The FieldMask to use when updating the security marks resource. This object should have the same structure as FieldMask |
startTime |
Object |
The time at which the updated SecurityMarks take effect. This object should have the same structure as Timestamp |
- Source:
- See:
UpdateSourceRequest
Request message for updating a source.
Properties:
| Name | Type | Description |
|---|---|---|
source |
Object |
The source resource to update. This object should have the same structure as Source |
updateMask |
Object |
The FieldMask to use when updating the source resource. This object should have the same structure as FieldMask |