package google.cloud.securitycenter.v1
Get desktop application:
View/edit binary Protocol Buffers messages
V1 APIs for Security Center service.
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.
string parent = 1
Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.
string filter = 2
Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<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 `true` and `false` without quotes.
string mute_annotation = 3
This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
BulkMuteFindingsRequest.MuteState mute_state = 4
Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings.
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
Request message for creating Security Health Analytics custom modules.
string parent = 1
Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`
optional security_health_analytics_custom_module = 2
Required. SecurityHealthAnalytics custom module to create. The provided name is ignored and reset with provided parent information and server-generated ID.
Creates a source.
Request message for creating a source.
string parent = 1
Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`.
optional source = 2
Required. The Source being created, only the display_name and description will be used. All other fields will be ignored.
Creates a finding. The corresponding source must exist for finding creation to succeed.
Request message for creating a finding.
string parent = 1
Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`.
string finding_id = 2
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.
optional finding = 3
Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource.
Creates a mute config.
Request message for creating a mute config.
string parent = 1
Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.
optional mute_config = 2
Required. The mute config being created.
string mute_config_id = 3
Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
Creates a notification config.
Request message for creating a notification config.
string parent = 1
Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.
string config_id = 2
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.
optional notification_config = 3
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.
Deletes an existing mute config.
Request message for deleting a mute config.
string name = 1
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}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.
Deletes a notification config.
Request message for deleting a notification config.
string name = 1
Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
Request message for deleting Security Health Analytics custom modules.
string name = 1
Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`
Get the simulation by name or the latest simulation for the given organization.
Request message for getting simulation. Simulation name can include "latest" to retrieve the latest simulation For example, "organizations/123/simulations/latest"
string name = 1
Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization}/simulations/latest` `organizations/{organization}/simulations/{simulation}`
message
simulation.proto:34Attack path simulation
string name = 1
Full resource name of the Simulation: `organizations/123/simulations/456`
optional create_time = 2
Output only. Time simulation was created
repeated resource_value_configs_metadata = 3
Resource value configurations' metadata used in this simulation. Maximum of 100.
CloudProvider cloud_provider = 4
Indicates which cloud provider was used in this simulation.
Get the valued resource by name
Request message for getting a valued resource.
string name = 1
Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`
Gets a BigQuery export.
Request message for retrieving a BigQuery export.
string name = 1
Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`
Gets the access control policy on the specified Source.
Gets a mute config.
Request message for retrieving a mute config.
string name = 1
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}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.
Gets a notification config.
Request message for getting a notification config.
string name = 1
Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.
Gets the settings for an organization.
Request message for getting organization settings.
string name = 1
Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`.
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
Request message for getting effective Security Health Analytics custom modules.
string name = 1
Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`
Retrieves a SecurityHealthAnalyticsCustomModule.
Request message for getting Security Health Analytics custom modules.
string name = 1
Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`
Gets a source.
Request message for getting a source.
string name = 1
Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`.
Filters an organization's assets and groups them by their specified properties.
Request message for grouping by assets.
string parent = 1
Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.
string filter = 2
Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<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 `true` and `false` without 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 = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_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 = 100` is 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 : ""`
string group_by = 3
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
optional compare_duration = 4
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_change` must be a specified field in `group_by`.
optional read_time = 5
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.
string page_token = 7
The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
int32 page_size = 8
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for grouping by assets.
repeated group_by_results = 1
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.
optional read_time = 2
Time used for executing the groupBy request.
string next_page_token = 3
Token to retrieve the next page of results, or empty if there are no more results.
int32 total_size = 4
The total number of results matching the query.
Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
Request message for grouping by findings.
string parent = 1
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/-`
string filter = 2
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. 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 `true` and `false` without 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 = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is 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: `=`, `:`
string group_by = 3
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
optional read_time = 4
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.
optional compare_duration = 5
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_change` must be a specified field in `group_by`.
string page_token = 7
The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.
int32 page_size = 8
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for group by findings.
repeated group_by_results = 1
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.
optional read_time = 2
Time used for executing the groupBy request.
string next_page_token = 3
Token to retrieve the next page of results, or empty if there are no more results.
int32 total_size = 4
The total number of results matching the query.
Lists an organization's assets.
Request message for listing assets.
string parent = 1
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]`, or `projects/[project_id]`.
string filter = 2
Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<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 `true` and `false` without 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 = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_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 = 100` is 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 : ""`
string order_by = 3
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
optional read_time = 4
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.
optional compare_duration = 5
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.
optional field_mask = 7
A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
string page_token = 8
The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.
int32 page_size = 9
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for listing assets.
repeated list_assets_results = 1
Assets matching the list request.
optional read_time = 2
Time used for executing the list request.
string next_page_token = 3
Token to retrieve the next page of results, or empty if there are no more results.
int32 total_size = 4
The total number of assets matching the query.
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
Request message for listing descendant Security Health Analytics custom modules.
string parent = 1
Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`
int32 page_size = 2
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
string page_token = 3
The value returned by the last call indicating a continuation
Response message for listing descendant Security Health Analytics custom modules.
repeated security_health_analytics_custom_modules = 1
Custom modules belonging to the requested parent and its descendants.
string next_page_token = 2
If not empty, indicates that there may be more custom modules to be returned.
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
Request message for listing findings.
string parent = 1
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/-`
string filter = 2
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. 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 `true` and `false` without 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 = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is 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: `=`, `:`
string order_by = 3
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
optional read_time = 4
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.
optional compare_duration = 5
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.
optional field_mask = 7
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
string page_token = 8
The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.
int32 page_size = 9
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for listing findings.
repeated list_findings_results = 1
Findings matching the list request.
optional read_time = 2
Time used for executing the list request.
string next_page_token = 3
Token to retrieve the next page of results, or empty if there are no more results.
int32 total_size = 4
The total number of findings matching the query.
Lists mute configs.
Request message for listing mute configs at a given scope e.g. organization, folder or project.
string parent = 1
Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.
int32 page_size = 2
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.
string page_token = 3
A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
Response message for listing mute configs.
repeated mute_configs = 1
The mute configs from the specified parent.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Lists notification configs.
Request message for listing notification configs.
string parent = 1
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]".
string page_token = 2
The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.
int32 page_size = 3
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for listing notification configs.
repeated notification_configs = 1
Notification configs belonging to the requested parent.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results.
Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
Request message for listing effective Security Health Analytics custom modules.
string parent = 1
Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`
int32 page_size = 2
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
string page_token = 3
The value returned by the last call indicating a continuation
Response message for listing effective Security Health Analytics custom modules.
repeated effective_security_health_analytics_custom_modules = 1
Effective custom modules belonging to the requested parent.
string next_page_token = 2
If not empty, indicates that there may be more effective custom modules to be returned.
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
Request message for listing Security Health Analytics custom modules.
string parent = 1
Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`
int32 page_size = 2
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
string page_token = 3
The value returned by the last call indicating a continuation
Response message for listing Security Health Analytics custom modules.
repeated security_health_analytics_custom_modules = 1
Custom modules belonging to the requested parent.
string next_page_token = 2
If not empty, indicates that there may be more custom modules to be returned.
Lists all sources belonging to an organization.
Request message for listing sources.
string parent = 1
Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.
string page_token = 2
The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.
int32 page_size = 7
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for listing sources.
repeated sources = 1
Sources belonging to the requested parent.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results.
Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
Request message for running asset discovery for an organization.
string parent = 1
Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`.
Updates the state of a finding.
Request message for updating a finding's state.
string name = 1
Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.
Finding.State state = 2
Required. The desired State of the finding.
optional start_time = 3
Required. The time at which the updated state takes effect.
Updates the mute state of a finding.
Request message for updating a finding's mute status.
string name = 1
Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.
Finding.Mute mute = 2
Required. The desired state of the Mute.
Sets the access control policy on the specified Source.
Returns the permissions that a caller has on the specified source.
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default.
string parent = 1
Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}`
optional custom_config = 2
Required. The custom configuration that you need to test.
optional resource = 3
Required. Resource data to simulate custom module against.
Response message for simulating a `SecurityHealthAnalyticsCustomModule` against a given resource.
optional result = 1
Result for test case in the corresponding request.
Updates external system. This is for a given finding.
Request message for updating a ExternalSystem resource.
optional external_system = 1
Required. The external system resource to update.
optional update_mask = 2
The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
Request message for updating or creating a finding.
optional finding = 1
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.
optional update_mask = 2
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.<property key>" in the field mask.
Updates a mute config.
Request message for updating a mute config.
optional mute_config = 1
Required. The mute config being updated.
optional update_mask = 2
The list of fields to be updated. If empty all mutable fields will be updated.
Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
Request message for updating a notification config.
optional notification_config = 1
Required. The notification config to update.
optional update_mask = 2
The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
Updates an organization's settings.
Request message for updating an organization's settings.
optional organization_settings = 1
Required. The organization settings resource to update.
optional update_mask = 2
The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated.
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
Request message for updating Security Health Analytics custom modules.
optional security_health_analytics_custom_module = 1
Required. The SecurityHealthAnalytics custom module to update.
optional update_mask = 2
The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
Updates a source.
Request message for updating a source.
optional source = 1
Required. The source resource to update.
optional update_mask = 2
The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.
Updates security marks.
Request message for updating a SecurityMarks resource.
optional security_marks = 1
Required. The security marks resource to update.
optional update_mask = 2
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>".
optional start_time = 3
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.
Creates a BigQuery export.
Request message for creating a BigQuery export.
string parent = 1
Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.
optional big_query_export = 2
Required. The BigQuery export being created.
string big_query_export_id = 3
Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
Deletes an existing BigQuery export.
Request message for deleting a BigQuery export.
string name = 1
Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`
Updates a BigQuery export.
Request message for updating a BigQuery export.
optional big_query_export = 1
Required. The BigQuery export being updated.
optional update_mask = 2
The list of fields to be updated. If empty all mutable fields will be updated.
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
Request message for listing BigQuery exports at a given scope e.g. organization, folder or project.
string parent = 1
Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.
int32 page_size = 2
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.
string page_token = 3
A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.
Response message for listing BigQuery exports.
repeated big_query_exports = 1
The BigQuery exports from the specified parent.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
Request to create an Event Threat Detection custom module.
string parent = 1
Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.
optional event_threat_detection_custom_module = 2
Required. The module to create. The event_threat_detection_custom_module.name will be ignored and server generated.
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
Request to delete an Event Threat Detection custom module.
string name = 1
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}`.
Gets an Event Threat Detection custom module.
Request to get an Event Threat Detection custom module.
string name = 1
Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
Request to list current and descendant resident Event Threat Detection custom modules.
string parent = 1
Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.
string page_token = 2
A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
int32 page_size = 3
The maximum number of modules 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.
Response for listing current and descendant resident Event Threat Detection custom modules.
repeated event_threat_detection_custom_modules = 1
Custom modules belonging to the requested parent.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
Request to list Event Threat Detection custom modules.
string parent = 1
Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.
string page_token = 2
A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
int32 page_size = 3
The maximum number of modules 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.
Response for listing Event Threat Detection custom modules.
repeated event_threat_detection_custom_modules = 1
Custom modules belonging to the requested parent.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
Request to update an Event Threat Detection custom module.
optional event_threat_detection_custom_module = 1
Required. The module being updated.
optional update_mask = 2
The list of fields to be updated. If empty all mutable fields will be updated.
Validates the given Event Threat Detection custom module.
Request to validate an Event Threat Detection custom module.
string parent = 1
Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.
string raw_text = 2
Required. The raw text of the module's contents. Used to generate error messages.
string type = 3
Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
Response to validating an Event Threat Detection custom module.
optional errors = 2
A list of errors returned by the validator. If the list is empty, there were no errors.
Gets an effective Event Threat Detection custom module at the given level.
Request to get an EffectiveEventThreatDetectionCustomModule.
string name = 1
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}`.
Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
Request to list effective Event Threat Detection custom modules.
string parent = 1
Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.
string page_token = 2
A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
int32 page_size = 3
The maximum number of modules 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.
Response for listing EffectiveEventThreatDetectionCustomModules.
repeated effective_event_threat_detection_custom_modules = 1
Effective custom modules belonging to the requested parent.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.
Request message to create multiple resource value configs
string parent = 1
Required. Resource name of the new ResourceValueConfig's parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.
repeated requests = 2
Required. The resource value configs to be created.
Response message for BatchCreateResourceValueConfigs
repeated resource_value_configs = 1
The resource value configs created
Deletes a ResourceValueConfig.
Request message to delete resource value config
string name = 1
Required. Name of the ResourceValueConfig to delete
Gets a ResourceValueConfig.
Request message to get resource value config
string name = 1
Required. Name of the resource value config to retrieve. Its format is `organizations/{organization}/resourceValueConfigs/{config_id}`.
Lists all ResourceValueConfigs.
Request message to list resource value configs of a parent
string parent = 1
Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]`
int32 page_size = 2
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.
string page_token = 3
A page token, received from a previous `ListResourceValueConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceValueConfigs` must match the call that provided the page token. page_size can be specified, and the new page_size will be used.
Response message to list resource value configs
repeated resource_value_configs = 1
The resource value configs from the specified parent.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
Updates an existing ResourceValueConfigs with new rules.
Request message to update resource value config
optional resource_value_config = 1
Required. The resource value config being updated.
optional update_mask = 2
The list of fields to be updated. If empty all mutable fields will be updated.
Lists the valued resources for a set of simulation results and filter.
Request message for listing the valued resources for a given simulation.
string parent = 1
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}`
string filter = 2
The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =
string page_token = 3
The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.
int32 page_size = 4
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
string order_by = 5
Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_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 ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.
Response message for listing the valued resources for a given simulation.
repeated valued_resources = 1
The valued resources that the attack path simulation identified.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results.
int32 total_size = 3
The estimated total number of results matching the query.
Lists the attack paths for a set of simulation results or valued resources and filter.
Request message for listing the attack paths for a given simulation or valued resource.
string parent = 1
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}`
string filter = 2
The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =
string page_token = 3
The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.
int32 page_size = 4
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Response message for listing the attack paths for a given simulation or valued resource.
repeated attack_paths = 1
The attack paths that the attack path simulation identified.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results.
message
access.proto:28Represents an access event.
Used in: ,
string principal_email = 1
Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a third party principal making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).
string caller_ip = 2
Caller's IP address, such as "1.1.1.1".
optional caller_ip_geo = 3
The caller IP's geolocation, which identifies where the call came from.
string user_agent_family = 4
Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
string user_agent = 12
The caller's user agent string associated with the finding.
string service_name = 5
This is the API service that the service account made a call to, e.g. "iam.googleapis.com"
string method_name = 6
The method that the service account called, e.g. "SetIamPolicy".
string principal_subject = 7
A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.
string service_account_key_name = 8
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}".
repeated service_account_delegation_info = 9
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.
string user_name = 11
A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.
message
cloud_armor.proto:95Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).
Used in:
double confidence = 1
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](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.
message
application.proto:28Represents an application associated with a finding.
Used in:
string base_uri = 1
The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.
string full_uri = 2
The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.
message
asset.proto:39Security 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.
Used in:
string name = 1
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}".
optional security_center_properties = 2
Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
map<string, > resource_properties = 7
Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.
optional security_marks = 8
User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset.
optional create_time = 9
The time at which the asset was created in Security Command Center.
optional update_time = 10
The time at which the asset was last updated or added in Cloud SCC.
optional iam_policy = 11
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.
string canonical_name = 13
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.
message
asset.proto:93Cloud 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.
Used in:
string policy_blob = 1
The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details.
message
asset.proto:51Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
Used in:
string resource_name = 1
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
string resource_type = 2
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.
string resource_parent = 3
The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
string resource_project = 4
The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
repeated string resource_owners = 5
Owners of the Google Cloud resource.
string resource_display_name = 6
The user defined display name for this resource.
string resource_parent_display_name = 7
The user defined display name for the parent of this resource.
string resource_project_display_name = 8
The user defined display name for the project of this resource.
repeated folders = 10
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.
message
cloud_armor.proto:105Information about DDoS attack volume and classification.
Used in:
int32 volume_pps = 1
Total PPS (packets per second) volume of attack.
int32 volume_bps = 2
Total BPS (bytes per second) volume of attack.
string classification = 3
Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.
message
attack_exposure.proto:30An attack exposure contains the results of an attack path simulation run.
Used in:
double score = 1
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.
optional latest_calculation_time = 2
The most recent time the attack exposure was updated on this finding.
string attack_exposure_result = 3
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`
AttackExposure.State state = 4
What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
int32 exposed_high_value_resources_count = 5
The number of high value resources that are exposed as a result of this finding.
int32 exposed_medium_value_resources_count = 6
The number of medium value resources that are exposed as a result of this finding.
int32 exposed_low_value_resources_count = 7
The number of high value resources that are exposed as a result of this finding.
This enum defines the various states an AttackExposure can be in.
Used in:
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.
message
attack_path.proto:30A path that an attacker could take to reach an exposed resource.
Used in:
string name = 1
The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78`
repeated path_nodes = 2
A list of nodes that exist in this attack path.
repeated edges = 3
A list of the edges between nodes in this attack path.
message
attack_path.proto:114Represents a connection between a source node and a destination node in this attack path.
Used in:
string source = 1
The attack node uuid of the source node.
string destination = 2
The attack node uuid of the destination node.
message
attack_path.proto:39Represents one point that an attacker passes through in this attack path.
Used in:
string resource = 1
The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
string resource_type = 2
The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
string display_name = 3
Human-readable name of this resource.
repeated associated_findings = 4
The findings associated with this node in the attack path.
string uuid = 5
Unique id of the attack path node.
repeated attack_steps = 6
A list of attack step nodes that exist in this attack path node.
message
attack_path.proto:72Detailed steps the attack can take between path nodes.
Used in:
string uuid = 1
Unique ID for one Node
NodeType type = 2
Attack step type. Can be either AND, OR or DEFENSE
string display_name = 3
User friendly name of the attack step
map<string, string> labels = 4
Attack step labels for metadata
string description = 5
Attack step description
The type of the incoming attack step node.
Used in:
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
message
attack_path.proto:41A finding that is associated with this node in the attack path.
Used in:
string canonical_finding = 1
Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789`
string finding_category = 2
The additional taxonomy group within findings from a given source.
string name = 3
Full resource name of the finding.
message
resource.proto:115AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.
Used in: ,
optional organization = 2
The AWS organization associated with the resource.
repeated organizational_units = 3
A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.
optional account = 4
The AWS account associated with the resource.
message
resource.proto:142An AWS account that is a member of an organization.
Used in:
string id = 1
The unique identifier (ID) of the account, containing exactly 12 digits.
string name = 2
The friendly name of this account.
message
resource.proto:119An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.
Used in:
string id = 1
The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits.
message
resource.proto:129An 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.
Used in:
string id = 1
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".
string name = 2
The friendly name of the OU.
message
resource.proto:163Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.
Used in: ,
repeated management_groups = 4
A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.
optional subscription = 5
The Azure subscription associated with the resource.
optional resource_group = 6
The Azure resource group associated with the resource.
message
resource.proto:165Represents an Azure management group.
Used in:
string id = 1
The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.
string display_name = 2
The display name of the Azure management group.
message
resource.proto:185Represents an Azure resource group.
Used in:
string name = 1
The name of the Azure resource group. This is not a UUID.
message
resource.proto:175Represents an Azure subscription.
Used in:
string id = 1
The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.
string display_name = 2
The display name of the Azure subscription.
Information related to Google Cloud Backup and DR Service findings.
Used in:
string backup_template = 1
The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.
repeated string policies = 2
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`.
string host = 3
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](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.
repeated string applications = 4
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`.
string storage_pool = 5
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](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.
repeated string policy_options = 6
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](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.
string profile = 7
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](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.
string appliance = 8
The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.
string backup_type = 9
The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.
optional backup_create_time = 10
The timestamp at which the Backup and DR backup was created.
message
bigquery_export.proto:32Configures how to deliver Findings to BigQuery Instance.
Used as response type in: SecurityCenter.CreateBigQueryExport, SecurityCenter.GetBigQueryExport, SecurityCenter.UpdateBigQueryExport
Used as field type in: , ,
string name = 1
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.
string description = 2
The description of the export (max of 1024 characters).
string filter = 3
Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<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 `true` and `false` without quotes.
string dataset = 4
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 (_).
optional create_time = 5
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.
optional update_time = 6
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.
string most_recent_editor = 7
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.
string principal = 8
Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
The mute state.
Used in:
MUTE_STATE_UNSPECIFIED = 0
Unused.
MUTED = 1
Matching findings will be muted (default).
UNDEFINED = 2
Matching findings will have their mute state cleared.
The response to a BulkMute request. Contains the LRO information.
(message has no fields)
message
cloud_armor.proto:30Fields related to Google Cloud Armor findings.
Used in:
optional security_policy = 1
Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.
optional requests = 2
Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview).
optional adaptive_protection = 3
Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview).
optional attack = 4
Information about DDoS attack volume and classification.
string threat_vector = 5
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.
optional duration = 6
Duration of attack from the start until the current moment (updated every 5 minutes).
message
cloud_dlp_data_profile.proto:36The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.
Used in:
string data_profile = 1
Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.
CloudDlpDataProfile.ParentType parent_type = 2
The resource hierarchy level at which the data profile was generated.
Parents for configurations that produce data profile findings.
Used in:
PARENT_TYPE_UNSPECIFIED = 0
Unspecified parent type.
ORGANIZATION = 1
Organization-level configurations.
PROJECT = 2
Project-level configurations.
message
cloud_dlp_inspection.proto:37Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.
Used in:
string inspect_job = 1
Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.
string info_type = 2
The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.
int64 info_type_count = 3
The number of times Cloud DLP found this infoType within this job and resource.
bool full_scan = 4
Whether Cloud DLP scanned the complete resource or a sampled subset.
message
log_entry.proto:39Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
Used in:
string insert_id = 1
A unique identifier for the log entry.
string log_id = 2
The type of the log (part of `log_name`. `log_name` is 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 the `LOG_ID` field in `LogEntry`.
string resource_container = 3
The organization, folder, or project of the monitored resource that produced this log entry.
optional timestamp = 4
The time the event described by the log entry occurred.
Enumeration representing the various cloud providers a finding's resource could reside in.
Used in: , , ,
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.
message
compliance.proto:29Contains compliance information about a security standard indicating unmet recommendations.
Used in:
string standard = 1
Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
string version = 2
Version of the standard or benchmark, for example, 1.1
repeated string ids = 3
Policies within the standard or benchmark, for example, A.12.4.1
message
connection.proto:28Contains information about the IP connection associated with the finding.
Used in:
string destination_ip = 1
Destination IP address. Not present for sockets that are listening and not connected.
int32 destination_port = 2
Destination port. Not present for sockets that are listening and not connected.
string source_ip = 3
Source IP address.
int32 source_port = 4
Source port.
Connection.Protocol protocol = 5
IANA Internet Protocol Number such as TCP(6) and UDP(17).
IANA Internet Protocol Number such as TCP(6) and UDP(17).
Used in:
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.
message
contact_details.proto:34The email address of a contact.
Used in:
string email = 1
An email address. For example, "`person123@company.com`".
message
contact_details.proto:28Details about specific contacts
Used in:
repeated contacts = 1
A list of contacts
message
container.proto:31Container associated with the finding.
Used in: , ,
string name = 1
Name of the container.
string uri = 2
Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
string image_id = 3
Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
repeated labels = 4
Container labels, as provided by the container runtime.
optional create_time = 5
The time that the container was created.
Request message to create single resource value config
Used in:
string parent = 1
Required. Resource name of the new ResourceValueConfig's parent.
optional resource_value_config = 2
Required. The resource value config being created.
Defines 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.
Used in: , ,
optional predicate = 1
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
optional custom_output = 2
Custom output properties.
optional resource_selector = 3
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
CustomConfig.Severity severity = 4
The severity to assign to findings generated by the module.
string description = 5
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.
string recommendation = 6
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 `nextSteps` property of the finding JSON.
A 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`.
Used in:
repeated properties = 1
A list of custom output properties to add to the finding.
An individual name-value pair that defines a custom source property.
Used in:
string name = 1
Name of the property for the custom output.
optional value_expression = 2
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.
Resource for selecting resource type.
Used in:
repeated string resource_types = 1
The resource types to run the detector on.
Defines the valid value options for the severity of a finding.
Used in:
SEVERITY_UNSPECIFIED = 0
Unspecified severity.
CRITICAL = 1
Critical severity.
HIGH = 2
High severity.
MEDIUM = 3
Medium severity.
LOW = 4
Low severity.
An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
Used in:
string description = 1
A description of the error, suitable for human consumption. Required.
string field_path = 2
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.
optional start = 3
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.
optional end = 4
The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed..
A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
Used in:
repeated errors = 1
message
vulnerability.proto:49CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.
Used in:
string id = 1
The unique identifier for the vulnerability. e.g. CVE-2021-34527
repeated references = 2
Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
optional cvssv3 = 3
Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
bool upstream_fix_available = 4
Whether upstream fix is available for the CVE.
Cve.RiskRating impact = 5
The potential impact of the vulnerability if it was to be exploited.
Cve.ExploitationActivity exploitation_activity = 6
The exploitation activity of the vulnerability in the wild.
bool observed_in_the_wild = 7
Whether or not the vulnerability has been observed in the wild.
bool zero_day = 8
Whether or not the vulnerability was zero day when the finding was published.
optional exploit_release_date = 9
Date the first publicly available exploit or PoC was released.
The possible values of exploitation activity of the vulnerability in the wild.
Used in:
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.
The possible values of impact of the vulnerability if it was to be exploited.
Used in:
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.
message
vulnerability.proto:138Common Vulnerability Scoring System version 3.
Used in:
double base_score = 1
The base score is a function of the base metric scores.
Cvssv3.AttackVector attack_vector = 5
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.
Cvssv3.AttackComplexity attack_complexity = 6
This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
Cvssv3.PrivilegesRequired privileges_required = 7
This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
Cvssv3.UserInteraction user_interaction = 8
This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
Cvssv3.Scope scope = 9
The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
Cvssv3.Impact confidentiality_impact = 10
This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
Cvssv3.Impact integrity_impact = 11
This metric measures the impact to integrity of a successfully exploited vulnerability.
Cvssv3.Impact availability_impact = 12
This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
Used in:
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.
This metric reflects the context by which vulnerability exploitation is possible.
Used in:
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.
The 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.
Used in:
IMPACT_UNSPECIFIED = 0
Invalid value.
IMPACT_HIGH = 1
High impact.
IMPACT_LOW = 2
Low impact.
IMPACT_NONE = 3
No impact.
This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
Used in:
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.
The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
Used in:
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.
This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
Used in:
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.
message
database.proto:34Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.
Used in:
string name = 1
Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.
string display_name = 2
The human-readable name of the database that the user connected to.
string user_name = 3
The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
string query = 4
The SQL statement that is associated with the database access.
repeated string grantees = 5
The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
string version = 6
The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
An 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_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. 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 also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only.
Used as response type in: SecurityCenter.GetEffectiveEventThreatDetectionCustomModule
Used as field type in:
string name = 1
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}`.
optional config = 2
Output only. Config for the effective module.
EffectiveEventThreatDetectionCustomModule.EnablementState enablement_state = 3
Output only. The effective state of enablement for the module at the given level of the hierarchy.
string type = 4
Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
string display_name = 5
Output only. The human readable name to be displayed for the module.
string description = 6
Output only. The description for the module.
enum EffectiveEventThreatDetectionCustomModule.EnablementState
effective_event_threat_detection_custom_module.proto:49The enablement state of the module.
Used in:
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.
An 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 `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. 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 also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only.
Used as response type in: SecurityCenter.GetEffectiveSecurityHealthAnalyticsCustomModule
Used as field type in:
string name = 1
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}"
optional custom_config = 2
Output only. The user-specified configuration for the module.
EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3
Output only. The effective state of enablement for the module at the given level of the hierarchy.
string display_name = 4
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.
enum EffectiveSecurityHealthAnalyticsCustomModule.EnablementState
effective_security_health_analytics_custom_module.proto:49The enablement state of the module.
Used in:
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.
message
process.proto:68A name-value pair representing an environment variable used in an operating system process.
Used in:
string name = 1
Environment variable name as a JSON encoded string.
string val = 2
Environment variable value as a JSON encoded string.
Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
Used as response type in: SecurityCenter.CreateEventThreatDetectionCustomModule, SecurityCenter.GetEventThreatDetectionCustomModule, SecurityCenter.UpdateEventThreatDetectionCustomModule
Used as field type in: , , ,
string name = 1
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}`.
optional config = 2
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.
string ancestor_module = 3
Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
EventThreatDetectionCustomModule.EnablementState enablement_state = 4
The state of enablement for the module at the given level of the hierarchy.
string type = 5
Type for the module. e.g. CONFIGURABLE_BAD_IP.
string display_name = 6
The human readable name to be displayed for the module.
string description = 7
The description for the module.
optional update_time = 8
Output only. The time the module was last updated.
string last_editor = 9
Output only. The editor the module was last updated by.
The enablement state of the module.
Used in:
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.
message
exfiltration.proto:46Resource where data was exfiltrated from or exfiltrated to.
Used in:
string name = 1
The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
repeated string components = 2
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.
message
exfiltration.proto:31Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.
Used in:
repeated sources = 1
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.
repeated targets = 2
If there are multiple targets, each target would get a complete copy of the "joined" source data.
int64 total_exfiltrated_bytes = 3
Total exfiltrated bytes processed for the entire job.
message
external_system.proto:31Representation of third party SIEM/SOAR fields within SCC.
Used as response type in: SecurityCenter.UpdateExternalSystem
Used as field type in: ,
string name = 1
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"
repeated string assignees = 2
References primary/secondary etc assignees in the external system.
string external_uid = 3
The identifier that's used to track the finding's corresponding case in the external system.
string status = 4
The most recent status of the finding's corresponding case, as reported by the external system.
optional external_system_update_time = 5
The time when the case was last updated, as reported by the external system.
string case_uri = 6
The link to the finding's corresponding case in the external system.
string case_priority = 7
The priority of the finding's corresponding case in the external system.
optional case_sla = 9
The SLA of the finding's corresponding case in the external system.
optional case_create_time = 10
The time when the case was created, as reported by the external system.
optional case_close_time = 11
The time when the case was closed, as reported by the external system.
optional ticket_info = 8
Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
message
external_system.proto:43Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
Used in:
string id = 1
The identifier of the ticket in the ticket system.
string assignee = 2
The assignee of the ticket in the ticket system.
string description = 3
The description of the ticket in the ticket system.
string uri = 4
The link to the ticket in the ticket system.
string status = 5
The latest status of the ticket, as reported by the ticket system.
optional update_time = 6
The time when the ticket was last updated, as reported by the ticket system.
message
file.proto:29File information about the related binary/library used by an executable, or the script used by a script interpreter
Used in: ,
string path = 1
Absolute path of the file as a JSON encoded string.
int64 size = 2
Size of the file in bytes.
string sha256 = 3
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.
int64 hashed_size = 4
The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
bool partially_hashed = 5
True when the hash covers only a prefix of the file.
string contents = 6
Prefix of the file contents as a JSON-encoded string.
optional disk_path = 7
Path of the file in terms of underlying disk/partition identifiers.
message
file.proto:31Path of the file in terms of underlying disk/partition identifiers.
Used in:
string partition_uuid = 1
UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
string relative_path = 2
Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
message
finding.proto:68Security 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.
Used as response type in: SecurityCenter.CreateFinding, SecurityCenter.SetFindingState, SecurityCenter.SetMute, SecurityCenter.UpdateFinding
Used as field type in: , , , ,
string name = 1
The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".
string parent = 2
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}"
string resource_name = 3
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.
Finding.State state = 4
The state of the finding.
string category = 5
The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
string external_uri = 6
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.
map<string, > source_properties = 7
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.
optional security_marks = 8
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.
optional event_time = 9
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.
optional create_time = 10
The time at which the finding was created in Security Command Center.
Finding.Severity severity = 12
The severity of the finding. This field is managed by the source that writes the finding.
string canonical_name = 14
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.
Finding.Mute mute = 15
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.FindingClass finding_class = 17
The class of the finding.
optional indicator = 18
Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
optional vulnerability = 20
Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
optional mute_update_time = 21
Output only. The most recent time this finding was muted or unmuted.
map<string, > external_systems = 22
Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
optional mitre_attack = 25
MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
optional access = 26
Access details associated with the finding, such as more information on the caller, which method was accessed, and from where.
repeated connections = 31
Contains information about the IP connection associated with the finding.
string mute_initiator = 28
Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.
optional mute_info = 61
Output only. The mute information regarding this finding.
repeated processes = 30
Represents operating system processes associated with the Finding.
map<string, > contacts = 33
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" } ] } }
repeated compliances = 34
Contains compliance information for security standards associated to the finding.
string parent_display_name = 36
Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics".
string description = 37
Contains more details about the finding.
optional exfiltration = 38
Represents exfiltrations associated with the finding.
repeated iam_bindings = 39
Represents IAM bindings associated with the finding.
string next_steps = 40
Steps to address the finding.
string module_name = 41
Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
repeated containers = 42
Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.
optional kubernetes = 43
Kubernetes resources associated with the finding.
optional database = 44
Database associated with the finding.
optional attack_exposure = 45
The results of an attack path simulation relevant to this finding.
repeated files = 46
File associated with the finding.
optional cloud_dlp_inspection = 48
Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
optional cloud_dlp_data_profile = 49
Cloud DLP data profile that is associated with the finding.
optional kernel_rootkit = 50
Signature of the kernel rootkit.
repeated org_policies = 51
Contains information about the org policies associated with the finding.
optional application = 53
Represents an application associated with the finding.
optional backup_disaster_recovery = 55
Fields related to Backup and DR findings.
optional security_posture = 56
The security posture associated with the finding.
repeated log_entries = 57
Log entries that are relevant to the finding.
repeated load_balancers = 58
The load balancers associated with the finding.
optional cloud_armor = 59
Fields related to Cloud Armor findings.
optional notebook = 63
Notebook associated with the finding.
optional toxic_combination = 64
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.
repeated group_memberships = 65
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.
Represents what kind of Finding it is.
Used in:
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.
Mute state a finding can be in.
Used in: , ,
MUTE_UNSPECIFIED = 0
Unspecified.
MUTED = 1
Finding has been muted.
UNMUTED = 2
Finding has been unmuted.
UNDEFINED = 4
Finding has never been muted/unmuted.
message
finding.proto:201Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.
Used in:
optional static_mute = 1
If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute.
repeated dynamic_mute_records = 2
The list of dynamic mute rules that currently match the finding.
message
finding.proto:215The record of a dynamic mute rule that matches the finding.
Used in:
string mute_config = 1
The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.
optional match_time = 2
When the dynamic mute rule first matched the finding.
message
finding.proto:205Information 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.
Used in:
Mute state = 1
The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.
optional apply_time = 2
When the static mute was applied.
The severity of the finding.
Used in:
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.
The state of the finding.
Used in: ,
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.
message
folder.proto:29Message that contains the resource name and display name of a folder resource.
Used in: , ,
string resource_folder = 1
Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
string resource_folder_display_name = 2
The user defined display name for this folder.
message
access.proto:108Represents a geographical location for a given access.
Used in:
string region_code = 1
A CLDR.
message
group_membership.proto:29Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.
Used in:
GroupMembership.GroupType group_type = 1
Type of group.
string group_id = 2
ID of the group.
Possible types of groups.
Used in:
GROUP_TYPE_UNSPECIFIED = 0
Default value.
GROUP_TYPE_TOXIC_COMBINATION = 1
Group represents a toxic combination.
Result containing the properties and count of a groupBy request.
Used in: ,
map<string, > properties = 1
Properties matching the groupBy fields in the request.
int64 count = 2
Total count of resources for the given properties.
message
iam_binding.proto:29Represents a particular IAM binding, which captures a member's role addition, removal, or state.
Used in:
IamBinding.Action action = 1
The action that was performed on a Binding.
string role = 2
Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner".
string member = 3
A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com".
The type of action performed on a Binding in a policy.
Used in:
ACTION_UNSPECIFIED = 0
Unspecified.
ADD = 1
Addition of a Binding.
REMOVE = 2
Removal of a Binding.
message
indicator.proto:32Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
Used in:
repeated string ip_addresses = 1
The list of IP addresses that are associated with the finding.
repeated string domains = 2
List of domains associated to the Finding.
repeated signatures = 3
The list of matched signatures indicating that the given process is present in the environment.
repeated string uris = 4
The list of URIs associated to the Findings.
message
indicator.proto:34Indicates what signature matched this process.
Used in:
oneof signature
memory_hash_signature = 6
Signature indicating that a binary family was matched.
yara_rule_signature = 7
Signature indicating that a YARA rule was matched.
ProcessSignature.SignatureType signature_type = 8
Describes the type of resource associated with the signature.
message
indicator.proto:36A signature corresponding to memory page hashes.
Used in:
string binary_family = 1
The binary family.
repeated detections = 4
The list of memory hash detections contributing to the binary family match.
message
indicator.proto:38Memory hash detection contributing to the binary family match.
Used in:
string binary = 2
The name of the binary associated with the memory hash signature detection.
double percent_pages_matched = 3
The percentage of memory page hashes in the signature that were matched.
Possible resource types to be associated with a signature.
Used in:
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.
message
indicator.proto:57A signature corresponding to a YARA rule.
Used in:
string yara_rule = 5
The name of the YARA rule.
message
kernel_rootkit.proto:28Kernel mode rootkit signatures.
Used in:
string name = 1
Rootkit name, when available.
bool unexpected_code_modification = 2
True if unexpected modifications of kernel code memory are present.
bool unexpected_read_only_data_modification = 3
True if unexpected modifications of kernel read-only data memory are present.
bool unexpected_ftrace_handler = 4
True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
bool unexpected_kprobe_handler = 5
True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
bool unexpected_kernel_code_pages = 6
True if kernel code pages that are not in the expected kernel or module code regions are present.
bool unexpected_system_call_handler = 7
True if system call handlers that are are not in the expected kernel or module code regions are present.
bool unexpected_interrupt_handler = 8
True if interrupt handlers that are are not in the expected kernel or module code regions are present.
bool unexpected_processes_in_runqueue = 9
True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.
message
kubernetes.proto:31Kubernetes-related attributes.
Used in:
repeated pods = 1
Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.
repeated nodes = 2
Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.
repeated node_pools = 3
GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.
repeated roles = 4
Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
repeated bindings = 5
Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
repeated access_reviews = 6
Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.
repeated objects = 7
Kubernetes objects related to the finding.
message
kubernetes.proto:135Conveys 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.
Used in:
string group = 1
The API group of the resource. "*" means all.
string ns = 2
Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty).
string name = 3
The name of the resource being requested. Empty means all.
string resource = 4
The optional resource type requested. "*" means all.
string subresource = 5
The optional subresource type.
string verb = 6
A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all.
string version = 7
The API version of the resource. "*" means all.
message
kubernetes.proto:89Represents a Kubernetes RoleBinding or ClusterRoleBinding.
Used in:
string ns = 1
Namespace for the binding.
string name = 2
Name for the binding.
optional role = 3
The Role or ClusterRole referenced by the binding.
repeated subjects = 4
Represents one or more subjects that are bound to the role. Not always available for PATCH requests.
message
kubernetes.proto:49Kubernetes nodes associated with the finding.
Used in: ,
string name = 1
[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
message
kubernetes.proto:56Provides GKE node pool information.
Used in:
string name = 1
Kubernetes node pool name.
repeated nodes = 2
Nodes associated with the finding.
message
kubernetes.proto:164Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.
Used in:
string group = 1
Kubernetes object group, such as "policy.k8s.io/v1".
string kind = 2
Kubernetes object kind, such as "Namespace".
string ns = 3
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/.
string name = 4
Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.
repeated containers = 5
Pod containers associated with this finding, if any.
message
kubernetes.proto:33A Kubernetes Pod.
Used in:
string ns = 1
Kubernetes Pod namespace.
string name = 2
Kubernetes Pod name.
repeated labels = 3
Pod labels. For Kubernetes containers, these are applied to the container.
repeated containers = 4
Pod containers associated with this finding, if any.
message
kubernetes.proto:65Kubernetes Role or ClusterRole.
Used in: ,
Role.Kind kind = 1
Role type.
string ns = 2
Role namespace.
string name = 3
Role name.
Types of Kubernetes roles.
Used in:
KIND_UNSPECIFIED = 0
Role type is not specified.
ROLE = 1
Kubernetes Role.
CLUSTER_ROLE = 2
Kubernetes ClusterRole.
message
kubernetes.proto:105Represents a Kubernetes subject.
Used in:
Subject.AuthType kind = 1
Authentication type for the subject.
string ns = 2
Namespace for the subject.
string name = 3
Name for the subject.
Auth types that can be used for the subject's kind field.
Used in:
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.
message
label.proto:31Represents 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](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
Used in: ,
string name = 1
Name of the label.
string value = 2
Value that corresponds to the label's name.
Result containing the Asset and its State.
Used in:
optional asset = 1
Asset matching the search request.
ListAssetsResult.StateChange state_change = 2
State change of the asset between the points in time.
The 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
Used in:
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.
Result containing the Finding and its StateChange.
Used in:
optional finding = 1
Finding matching the search request.
ListFindingsResult.StateChange state_change = 2
State change of the finding between the points in time.
optional resource = 3
Output only. Resource that is associated with this finding.
Information related to the Google Cloud resource that is associated with this finding.
Used in:
string name = 1
The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
string display_name = 8
The human readable name of the resource.
string type = 6
The full resource type of the resource.
string project_name = 2
The full resource name of project that the resource belongs to.
string project_display_name = 3
The project ID that the resource belongs to.
string parent_name = 4
The full resource name of resource's parent.
string parent_display_name = 5
The human readable name of resource's parent.
repeated folders = 7
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.
CloudProvider cloud_provider = 9
Indicates which cloud provider the finding is from.
string organization = 10
Indicates which organization / tenant the finding is for.
string service = 11
The service or resource provider associated with the resource.
string location = 12
The region or location of the service (if applicable).
oneof cloud_provider_metadata
aws_metadata = 16
The AWS metadata associated with the finding.
azure_metadata = 17
The Azure metadata associated with the finding.
optional resource_path = 18
Provides the path to the resource within the resource hierarchy.
string resource_path_string = 19
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 of `org/{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 of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.
The 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
Used in:
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.
message
load_balancer.proto:29Contains information related to the load balancer associated with the finding.
Used in:
string name = 1
The name of the load balancer associated with the finding.
message
log_entry.proto:30An individual entry in a log.
Used in:
oneof log_entry
cloud_logging_entry = 1
An individual entry in a log stored in Cloud Logging.
message
mitre_attack.proto:29MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
Used in:
MitreAttack.Tactic primary_tactic = 1
The MITRE ATT&CK tactic most closely represented by this finding, if any.
repeated MitreAttack.Technique primary_techniques = 2
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`).
repeated MitreAttack.Tactic additional_tactics = 3
Additional MITRE ATT&CK tactics related to this finding, if any.
repeated MitreAttack.Technique additional_techniques = 4
Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.
string version = 5
The MITRE ATT&CK version referenced by the above fields. E.g. "8".
MITRE ATT&CK tactics that can be referenced by SCC findings. See: https://attack.mitre.org/tactics/enterprise/
Used in:
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
MITRE ATT&CK techniques that can be referenced by SCC findings. See: https://attack.mitre.org/techniques/enterprise/ Next ID: 65
Used in:
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
message
mute_config.proto:33A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
Used as response type in: SecurityCenter.CreateMuteConfig, SecurityCenter.GetMuteConfig, SecurityCenter.UpdateMuteConfig
Used as field type in: , ,
string name = 1
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}`
string display_name = 2
The human readable name to be displayed for the mute config.
string description = 3
A description of the mute config.
string filter = 4
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: `=`, `:`
optional create_time = 5
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.
optional update_time = 6
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.
string most_recent_editor = 7
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.
MuteConfig.MuteConfigType type = 8
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.
optional expiry_time = 9
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.
The type of MuteConfig.
Used in:
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).
message
notebook.proto:32Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.
Used in:
string name = 1
The name of the notebook.
string service = 2
The source notebook service, for example, "Colab Enterprise".
string last_author = 3
The user ID of the latest author to modify the notebook.
optional notebook_update_time = 4
The most recent time the notebook was updated.
message
notification_config.proto:38Cloud 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.
Used as response type in: SecurityCenter.CreateNotificationConfig, SecurityCenter.GetNotificationConfig, SecurityCenter.UpdateNotificationConfig
Used as field type in: , ,
string name = 1
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".
string description = 2
The description of the notification config (max of 1024 characters).
string pubsub_topic = 3
The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
string service_account = 4
Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
oneof notify_config
The config for triggering notifications.
streaming_config = 5
The config for triggering streaming-based notifications.
message
notification_config.proto:50The config for streaming-based notifications, which send each event as soon as it is detected.
Used in:
string filter = 1
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 `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. 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 `true` and `false` without quotes.
message
notification_message.proto:31Cloud SCC's Notification
string notification_config_name = 1
Name of the notification config that generated current notification.
oneof event
Notification Event.
finding = 2
If it's a Finding based notification config, this field will be populated.
optional resource = 3
The Cloud resource tied to this notification's Finding.
message
org_policy.proto:30Contains information about the org policies associated with the finding.
Used in:
string name = 1
The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}"
message
organization_settings.proto:30User specified settings that are attached to the Security Command Center organization.
Used as response type in: SecurityCenter.GetOrganizationSettings, SecurityCenter.UpdateOrganizationSettings
Used as field type in:
string name = 1
The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings".
bool enable_asset_discovery = 2
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 to `false`, all historical assets will remain, but discovery of future assets will not occur.
optional asset_discovery_config = 3
The configuration used for Asset Discovery runs.
message
organization_settings.proto:39The configuration used for Asset Discovery runs.
Used in:
repeated string project_ids = 1
The project ids to use for filtering asset discovery.
AssetDiscoveryConfig.InclusionMode inclusion_mode = 2
The mode to use for filtering asset discovery.
repeated string folder_ids = 3
The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966.
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.
Used in:
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.
message
vulnerability.proto:294Package is a generic definition of a package.
Used in:
string package_name = 1
The name of the package where the vulnerability was detected.
string cpe_uri = 2
The CPE URI where the vulnerability was detected.
string package_type = 3
Type of package, for example, os, maven, or go.
string package_version = 4
The version of the package.
A position in the uploaded text version of a module.
Used in:
int32 line_number = 1
int32 column_number = 2
message
process.proto:30Represents an operating system process.
Used in:
string name = 12
The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.
optional binary = 3
File information for the process executable.
repeated libraries = 4
File information for libraries loaded by the process.
optional script = 5
When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter.
repeated string args = 6
Process arguments as JSON encoded strings.
bool arguments_truncated = 7
True if `args` is incomplete.
repeated env_variables = 8
Process environment variables.
bool env_variables_truncated = 9
True if `env_variables` is incomplete.
int64 pid = 10
The process ID.
int64 parent_pid = 11
The parent process ID.
message
vulnerability.proto:128Additional Links
Used in:
string source = 1
Source of the reference e.g. NVD
string uri = 2
Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
message
cloud_armor.proto:77Information about the requests relevant to the finding.
Used in:
double ratio = 1
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.
int32 short_term_allowed = 2
Allowed RPS (requests per second) in the short term.
int32 long_term_allowed = 3
Allowed RPS (requests per second) over the long term.
int32 long_term_denied = 4
Denied RPS (requests per second) over the long term.
message
resource.proto:31Information related to the Google Cloud resource.
Used in:
string name = 1
The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
string display_name = 8
The human readable name of the resource.
string type = 6
The full resource type of the resource.
string project = 2
The full resource name of project that the resource belongs to.
string project_display_name = 3
The project ID that the resource belongs to.
string parent = 4
The full resource name of resource's parent.
string parent_display_name = 5
The human readable name of resource's parent.
repeated folders = 7
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.
CloudProvider cloud_provider = 9
Indicates which cloud provider the resource resides in.
string organization = 10
Indicates which organization or tenant in the cloud provider the finding applies to.
string service = 11
The parent service or product from which the resource is provided, for example, GKE or SNS.
string location = 12
The region or location of the service (if applicable).
oneof cloud_provider_metadata
aws_metadata = 16
The AWS metadata associated with the finding.
azure_metadata = 17
The Azure metadata associated with the finding.
optional resource_path = 18
Provides the path to the resource within the resource hierarchy.
string resource_path_string = 19
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 of `org/{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 of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.
message
resource.proto:203Represents the path of resources leading up to the resource this finding is about.
Used in: ,
repeated nodes = 1
The list of nodes that make the up resource path, ordered from lowest level to highest level.
message
resource.proto:239A node within the resource path. Each node represents a resource within the resource hierarchy.
Used in:
ResourcePathNodeType node_type = 1
The type of resource this node represents.
string id = 2
The ID of the resource this node represents.
string display_name = 3
The display name of the resource this node represents.
The type of resource the node represents.
Used in:
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.
Value enum to map to a resource
Used in: ,
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
message
resource_value_config.proto:34A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
Used as response type in: SecurityCenter.GetResourceValueConfig, SecurityCenter.UpdateResourceValueConfig
Used as field type in: , , ,
string name = 1
Name for the resource value configuration
ResourceValue resource_value = 2
Required. Resource value level this expression represents
repeated string tag_values = 3
Required. Tag values combined with `AND` to 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
string resource_type = 4
Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
string scope = 5
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 `AND` of other resources.
map<string, string> resource_labels_selector = 6
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
string description = 7
Description of the resource value configuration.
optional create_time = 8
Output only. Timestamp this resource value configuration was created.
optional update_time = 9
Output only. Timestamp this resource value configuration was last updated.
CloudProvider cloud_provider = 10
Cloud provider this configuration applies to
optional sensitive_data_protection_mapping = 11
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".
message
resource_value_config.proto:45Resource 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.
Used in:
ResourceValue high_sensitivity_mapping = 1
Resource value mapping for high-sensitivity Sensitive Data Protection findings
ResourceValue medium_sensitivity_mapping = 2
Resource value mapping for medium-sensitivity Sensitive Data Protection findings
message
valued_resource.proto:85Metadata about a ResourceValueConfig. For example, id and name.
Used in: ,
string name = 1
Resource value config name
Response of asset discovery run
RunAssetDiscoveryResponse.State state = 1
The state of an asset discovery run.
optional duration = 2
The duration between asset discovery run start and end
The state of an asset discovery run.
Used in:
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.
message
vulnerability.proto:309SecurityBulletin are notifications of vulnerabilities of Google products.
Used in:
string bulletin_id = 1
ID of the bulletin corresponding to the vulnerability.
optional submission_time = 2
Submission time of this Security Bulletin.
string suggested_upgrade_version = 3
This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0
Represents 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.
Used as response type in: SecurityCenter.CreateSecurityHealthAnalyticsCustomModule, SecurityCenter.GetSecurityHealthAnalyticsCustomModule, SecurityCenter.UpdateSecurityHealthAnalyticsCustomModule
Used as field type in: , , ,
string name = 1
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.
string display_name = 2
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.
SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4
The enablement state of the custom module.
optional update_time = 5
Output only. The time at which the custom module was last updated.
string last_editor = 6
Output only. The editor that last updated the custom module.
string ancestor_module = 7
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_module` specifies the organization or folder from which the custom module is inherited.
optional custom_config = 8
The user specified custom configuration for the module.
enum SecurityHealthAnalyticsCustomModule.EnablementState
security_health_analytics_custom_module.proto:52Possible enablement states of a custom module.
Used in:
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.
message
security_marks.proto:32User 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.
Used as response type in: SecurityCenter.UpdateSecurityMarks
Used as field type in: , ,
string name = 1
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".
map<string, string> marks = 2
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)
string canonical_name = 3
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"
message
cloud_armor.proto:62Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.
Used in:
string name = 1
The name of the Google Cloud Armor security policy, for example, "my-security-policy".
string type = 2
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'.
bool preview = 3
Whether or not the associated rule or policy is in preview mode.
message
security_posture.proto:32Represents 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.
Used in:
string name = 1
Name of the posture, for example, `CIS-Posture`.
string revision_id = 2
The version of the posture, for example, `c7cfa2a8`.
string posture_deployment_resource = 3
The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.
string posture_deployment = 4
The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.
string changed_policy = 5
The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.
string policy_set = 6
The name of the updated policyset, for example, `cis-policyset`.
string policy = 7
The ID of the updated policy, for example, `compute-policy-1`.
repeated policy_drift_details = 8
The details about a change in an updated policy that violates the deployed posture.
message
security_posture.proto:35The policy field that violates the deployed posture and its expected and detected values.
Used in:
string field = 1
The name of the updated field, for example constraint.implementation.policy_rules[0].enforce
string expected_value = 2
The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`.
string detected_value = 3
The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`.
message
access.proto:93Identity delegation history of an authenticated service account.
Used in:
string principal_email = 1
The email address of a Google account.
string principal_subject = 2
A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`
Manually constructed resource name. If the custom module evaluates against only the resource data, you can omit the `iam_policy_data` field. If it evaluates only the `iam_policy_data` field, you can omit the resource data.
Used in:
string resource_type = 1
Required. The type of the resource, for example, `compute.googleapis.com/Disk`.
optional resource_data = 2
Optional. A representation of the Google Cloud resource. Should match the Google Cloud resource JSON format.
optional iam_policy_data = 3
Optional. A representation of the IAM policy.
Possible test result.
Used in:
oneof result
finding = 1
Finding that would be published for the test case, if a violation is detected.
no_violation = 2
Indicates that the test case does not trigger any violation.
error = 3
Error encountered during the test.
message
source.proto:32Security 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.
Used as response type in: SecurityCenter.CreateSource, SecurityCenter.GetSource, SecurityCenter.UpdateSource
Used as field type in: , ,
string name = 1
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}"
string display_name = 2
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).
string description = 3
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."
string canonical_name = 14
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.
message
toxic_combination.proto:30Contains 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.
Used in:
double attack_exposure_score = 1
The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) 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.
repeated string related_findings = 2
List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.
message
valued_resource.proto:30A resource that is determined to have value to a user's system
Used as response type in: SecurityCenter.GetValuedResource
Used as field type in:
string name = 1
Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789`
string resource = 2
The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource.
string resource_type = 3
The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource.
string display_name = 4
Human-readable name of the valued resource.
ValuedResource.ResourceValue resource_value = 5
How valuable this resource is.
double exposed_score = 6
Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.
repeated resource_value_configs_used = 7
List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100.
How valuable the resource is.
Used in:
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.
message
vulnerability.proto:30Refers to common vulnerability fields e.g. cve, cvss, cwe etc.
Used in:
optional cve = 1
CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
optional offending_package = 2
The offending package is relevant to the finding.
optional fixed_package = 3
The fixed package is relevant to the finding.
optional security_bulletin = 4
The security bulletin is relevant to this finding.