You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
887 lines
43 KiB
887 lines
43 KiB
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="securitycenter_v1.html">Cloud Security Command Center API</a> . <a href="securitycenter_v1.organizations.html">organizations</a> . <a href="securitycenter_v1.organizations.sources.html">sources</a> . <a href="securitycenter_v1.organizations.sources.findings.html">findings</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#create">create(parent, body, x__xgafv=None, findingId=None)</a></code></p>
|
|
<p class="firstline">Creates a finding. The corresponding source must exist for finding creation</p>
|
|
<p class="toc_element">
|
|
<code><a href="#group">group(parent, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Filters an organization or source's findings and groups them by their</p>
|
|
<p class="toc_element">
|
|
<code><a href="#group_next">group_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(parent, orderBy=None, pageSize=None, x__xgafv=None, compareDuration=None, pageToken=None, fieldMask=None, readTime=None, filter=None)</a></code></p>
|
|
<p class="firstline">Lists an organization or source's findings.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates or updates a finding. The corresponding source must exist for a</p>
|
|
<p class="toc_element">
|
|
<code><a href="#setState">setState(name, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates the state of a finding.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#updateSecurityMarks">updateSecurityMarks(name, body, startTime=None, updateMask=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates security marks.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="create">create(parent, body, x__xgafv=None, findingId=None)</code>
|
|
<pre>Creates a finding. The corresponding source must exist for finding creation
|
|
to succeed.
|
|
|
|
Args:
|
|
parent: string, Resource name of the new finding's parent. Its format should be
|
|
"organizations/[organization_id]/sources/[source_id]". (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Cloud Security Command Center (Cloud SCC) finding.
|
|
#
|
|
# A finding is a record of assessment data (security, risk, health or privacy)
|
|
# ingested into Cloud SCC for presentation, notification, analysis,
|
|
# policy testing, and enforcement. For example, an XSS vulnerability in an
|
|
# App Engine application is a finding.
|
|
"category": "A String", # The additional taxonomy group within findings from a given source.
|
|
# This field is immutable after creation time.
|
|
# Example: "XSS_FLASH_INJECTION"
|
|
"eventTime": "A String", # The time at which the event took place. For example, if the finding
|
|
# represents an open firewall it would capture the time the detector believes
|
|
# the firewall became open. The accuracy is determined by the detector.
|
|
"sourceProperties": { # 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.
|
|
"a_key": "",
|
|
},
|
|
"name": "A String", # The relative resource name of this finding. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Example:
|
|
# "organizations/123/sources/456/findings/789"
|
|
"parent": "A String", # The relative resource name of the source the finding belongs to. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# This field is immutable after creation time.
|
|
# For example:
|
|
# "organizations/123/sources/456"
|
|
"state": "A String", # The state of the finding.
|
|
"resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
|
|
# finding is for. See:
|
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
|
# This field is immutable after creation time.
|
|
"securityMarks": { # User specified security marks that are attached to the parent Cloud Security # 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.
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
},
|
|
"createTime": "A String", # The time at which the finding was created in Cloud SCC.
|
|
"externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
|
|
# where additional information about the finding can be found. This field is
|
|
# guaranteed to be either empty or a well formed URL.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
findingId: string, Unique identifier provided by the client within the parent scope.
|
|
It must be alphanumeric and less than or equal to 32 characters and
|
|
greater than 0 characters in length.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Cloud Security Command Center (Cloud SCC) finding.
|
|
#
|
|
# A finding is a record of assessment data (security, risk, health or privacy)
|
|
# ingested into Cloud SCC for presentation, notification, analysis,
|
|
# policy testing, and enforcement. For example, an XSS vulnerability in an
|
|
# App Engine application is a finding.
|
|
"category": "A String", # The additional taxonomy group within findings from a given source.
|
|
# This field is immutable after creation time.
|
|
# Example: "XSS_FLASH_INJECTION"
|
|
"eventTime": "A String", # The time at which the event took place. For example, if the finding
|
|
# represents an open firewall it would capture the time the detector believes
|
|
# the firewall became open. The accuracy is determined by the detector.
|
|
"sourceProperties": { # 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.
|
|
"a_key": "",
|
|
},
|
|
"name": "A String", # The relative resource name of this finding. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Example:
|
|
# "organizations/123/sources/456/findings/789"
|
|
"parent": "A String", # The relative resource name of the source the finding belongs to. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# This field is immutable after creation time.
|
|
# For example:
|
|
# "organizations/123/sources/456"
|
|
"state": "A String", # The state of the finding.
|
|
"resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
|
|
# finding is for. See:
|
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
|
# This field is immutable after creation time.
|
|
"securityMarks": { # User specified security marks that are attached to the parent Cloud Security # 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.
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
},
|
|
"createTime": "A String", # The time at which the finding was created in Cloud SCC.
|
|
"externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
|
|
# where additional information about the finding can be found. This field is
|
|
# guaranteed to be either empty or a well formed URL.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="group">group(parent, body, x__xgafv=None)</code>
|
|
<pre>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/123/sources/-/findings
|
|
|
|
Args:
|
|
parent: string, Name of the source to groupBy. Its format is
|
|
"organizations/[organization_id]/sources/[source_id]". To groupBy across
|
|
all sources provide a source_id of `-`. For example:
|
|
organizations/123/sources/- (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Request message for grouping by findings.
|
|
"pageSize": 42, # The maximum number of results to return in a single response. Default is
|
|
# 10, minimum is 1, maximum is 1000.
|
|
"compareDuration": "A String", # 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 at the start of
|
|
# compare_duration, but changed its state at read_time.
|
|
# * "UNCHANGED": indicates that the finding was present at the start of
|
|
# compare_duration and did not change state at read_time.
|
|
# * "ADDED": indicates that the finding was not present at the start
|
|
# of compare_duration, but was present 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`.
|
|
"filter": "A String", # 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: `>`, `<`, `>=`, `<=`
|
|
# * security_marks: `=`, `:`
|
|
# * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
|
|
#
|
|
# For example, `source_properties.size = 100` is a valid filter string.
|
|
"pageToken": "A String", # 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.
|
|
"groupBy": "A String", # 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:
|
|
#
|
|
# * resource_name
|
|
# * category
|
|
# * state
|
|
# * parent
|
|
#
|
|
# The following fields are supported when compare_duration is set:
|
|
#
|
|
# * state_change
|
|
"readTime": "A String", # 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.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for group by findings.
|
|
"totalSize": 42, # The total number of results matching the query.
|
|
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
|
|
# results.
|
|
"groupByResults": [ # 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.
|
|
{ # Result containing the properties and count of a groupBy request.
|
|
"count": "A String", # Total count of resources for the given properties.
|
|
"properties": { # Properties matching the groupBy fields in the request.
|
|
"a_key": "",
|
|
},
|
|
},
|
|
],
|
|
"readTime": "A String", # Time used for executing the groupBy request.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="group_next">group_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(parent, orderBy=None, pageSize=None, x__xgafv=None, compareDuration=None, pageToken=None, fieldMask=None, readTime=None, filter=None)</code>
|
|
<pre>Lists an organization or source's findings.
|
|
|
|
To list across all sources provide a `-` as the source id.
|
|
Example: /v1/organizations/123/sources/-/findings
|
|
|
|
Args:
|
|
parent: string, Name of the source the findings belong to. Its format is
|
|
"organizations/[organization_id]/sources/[source_id]". To list across all
|
|
sources provide a source_id of `-`. For example:
|
|
organizations/123/sources/- (required)
|
|
orderBy: string, Expression that defines what fields and order to use for sorting. The
|
|
string value should follow SQL syntax: comma separated list of fields. For
|
|
example: "name,resource_properties.a_property". The default sorting order
|
|
is ascending. To specify descending order for a field, a suffix " desc"
|
|
should be appended to the field name. For example: "name
|
|
desc,source_properties.a_property". Redundant space characters in the
|
|
syntax are insignificant. "name desc,source_properties.a_property" and "
|
|
name desc , source_properties.a_property " are equivalent.
|
|
|
|
The following fields are supported:
|
|
name
|
|
parent
|
|
state
|
|
category
|
|
resource_name
|
|
event_time
|
|
source_properties
|
|
security_marks
|
|
pageSize: integer, The maximum number of results to return in a single response. Default is
|
|
10, minimum is 1, maximum is 1000.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
compareDuration: string, 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 at the start of
|
|
compare_duration, but changed its state at read_time.
|
|
* "UNCHANGED": indicates that the finding was present at the start of
|
|
compare_duration and did not change state at read_time.
|
|
* "ADDED": indicates that the finding was not present at the start
|
|
of compare_duration, but was present 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.
|
|
pageToken: string, 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.
|
|
fieldMask: string, Optional.
|
|
|
|
A field mask to specify the Finding fields to be listed in the response.
|
|
An empty field mask will list all fields.
|
|
readTime: string, 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.
|
|
filter: string, Expression that defines the filter to apply across findings.
|
|
The expression is a list of one or more restrictions combined via logical
|
|
operators `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: `>`, `<`, `>=`, `<=`
|
|
security_marks: `=`, `:`
|
|
source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
|
|
|
|
For example, `source_properties.size = 100` is a valid filter string.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for listing findings.
|
|
"totalSize": 42, # The total number of findings matching the query.
|
|
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
|
|
# results.
|
|
"listFindingsResults": [ # Findings matching the list request.
|
|
{ # Result containing the Finding and its StateChange.
|
|
"finding": { # Cloud Security Command Center (Cloud SCC) finding. # Finding matching the search request.
|
|
#
|
|
# A finding is a record of assessment data (security, risk, health or privacy)
|
|
# ingested into Cloud SCC for presentation, notification, analysis,
|
|
# policy testing, and enforcement. For example, an XSS vulnerability in an
|
|
# App Engine application is a finding.
|
|
"category": "A String", # The additional taxonomy group within findings from a given source.
|
|
# This field is immutable after creation time.
|
|
# Example: "XSS_FLASH_INJECTION"
|
|
"eventTime": "A String", # The time at which the event took place. For example, if the finding
|
|
# represents an open firewall it would capture the time the detector believes
|
|
# the firewall became open. The accuracy is determined by the detector.
|
|
"sourceProperties": { # 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.
|
|
"a_key": "",
|
|
},
|
|
"name": "A String", # The relative resource name of this finding. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Example:
|
|
# "organizations/123/sources/456/findings/789"
|
|
"parent": "A String", # The relative resource name of the source the finding belongs to. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# This field is immutable after creation time.
|
|
# For example:
|
|
# "organizations/123/sources/456"
|
|
"state": "A String", # The state of the finding.
|
|
"resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
|
|
# finding is for. See:
|
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
|
# This field is immutable after creation time.
|
|
"securityMarks": { # User specified security marks that are attached to the parent Cloud Security # 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.
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
},
|
|
"createTime": "A String", # The time at which the finding was created in Cloud SCC.
|
|
"externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
|
|
# where additional information about the finding can be found. This field is
|
|
# guaranteed to be either empty or a well formed URL.
|
|
},
|
|
"stateChange": "A String", # State change of the finding between the points in time.
|
|
},
|
|
],
|
|
"readTime": "A String", # Time used for executing the list request.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
|
|
<pre>Creates or updates a finding. The corresponding source must exist for a
|
|
finding creation to succeed.
|
|
|
|
Args:
|
|
name: string, The relative resource name of this finding. See:
|
|
https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
Example:
|
|
"organizations/123/sources/456/findings/789" (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Cloud Security Command Center (Cloud SCC) finding.
|
|
#
|
|
# A finding is a record of assessment data (security, risk, health or privacy)
|
|
# ingested into Cloud SCC for presentation, notification, analysis,
|
|
# policy testing, and enforcement. For example, an XSS vulnerability in an
|
|
# App Engine application is a finding.
|
|
"category": "A String", # The additional taxonomy group within findings from a given source.
|
|
# This field is immutable after creation time.
|
|
# Example: "XSS_FLASH_INJECTION"
|
|
"eventTime": "A String", # The time at which the event took place. For example, if the finding
|
|
# represents an open firewall it would capture the time the detector believes
|
|
# the firewall became open. The accuracy is determined by the detector.
|
|
"sourceProperties": { # 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.
|
|
"a_key": "",
|
|
},
|
|
"name": "A String", # The relative resource name of this finding. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Example:
|
|
# "organizations/123/sources/456/findings/789"
|
|
"parent": "A String", # The relative resource name of the source the finding belongs to. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# This field is immutable after creation time.
|
|
# For example:
|
|
# "organizations/123/sources/456"
|
|
"state": "A String", # The state of the finding.
|
|
"resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
|
|
# finding is for. See:
|
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
|
# This field is immutable after creation time.
|
|
"securityMarks": { # User specified security marks that are attached to the parent Cloud Security # 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.
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
},
|
|
"createTime": "A String", # The time at which the finding was created in Cloud SCC.
|
|
"externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
|
|
# where additional information about the finding can be found. This field is
|
|
# guaranteed to be either empty or a well formed URL.
|
|
}
|
|
|
|
updateMask: string, 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.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Cloud Security Command Center (Cloud SCC) finding.
|
|
#
|
|
# A finding is a record of assessment data (security, risk, health or privacy)
|
|
# ingested into Cloud SCC for presentation, notification, analysis,
|
|
# policy testing, and enforcement. For example, an XSS vulnerability in an
|
|
# App Engine application is a finding.
|
|
"category": "A String", # The additional taxonomy group within findings from a given source.
|
|
# This field is immutable after creation time.
|
|
# Example: "XSS_FLASH_INJECTION"
|
|
"eventTime": "A String", # The time at which the event took place. For example, if the finding
|
|
# represents an open firewall it would capture the time the detector believes
|
|
# the firewall became open. The accuracy is determined by the detector.
|
|
"sourceProperties": { # 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.
|
|
"a_key": "",
|
|
},
|
|
"name": "A String", # The relative resource name of this finding. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Example:
|
|
# "organizations/123/sources/456/findings/789"
|
|
"parent": "A String", # The relative resource name of the source the finding belongs to. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# This field is immutable after creation time.
|
|
# For example:
|
|
# "organizations/123/sources/456"
|
|
"state": "A String", # The state of the finding.
|
|
"resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
|
|
# finding is for. See:
|
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
|
# This field is immutable after creation time.
|
|
"securityMarks": { # User specified security marks that are attached to the parent Cloud Security # 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.
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
},
|
|
"createTime": "A String", # The time at which the finding was created in Cloud SCC.
|
|
"externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
|
|
# where additional information about the finding can be found. This field is
|
|
# guaranteed to be either empty or a well formed URL.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="setState">setState(name, body, x__xgafv=None)</code>
|
|
<pre>Updates the state of a finding.
|
|
|
|
Args:
|
|
name: string, The relative resource name of the finding. See:
|
|
https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
Example:
|
|
"organizations/123/sources/456/finding/789". (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Request message for updating a finding's state.
|
|
"state": "A String", # The desired State of the finding.
|
|
"startTime": "A String", # The time at which the updated state takes effect.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Cloud Security Command Center (Cloud SCC) finding.
|
|
#
|
|
# A finding is a record of assessment data (security, risk, health or privacy)
|
|
# ingested into Cloud SCC for presentation, notification, analysis,
|
|
# policy testing, and enforcement. For example, an XSS vulnerability in an
|
|
# App Engine application is a finding.
|
|
"category": "A String", # The additional taxonomy group within findings from a given source.
|
|
# This field is immutable after creation time.
|
|
# Example: "XSS_FLASH_INJECTION"
|
|
"eventTime": "A String", # The time at which the event took place. For example, if the finding
|
|
# represents an open firewall it would capture the time the detector believes
|
|
# the firewall became open. The accuracy is determined by the detector.
|
|
"sourceProperties": { # 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.
|
|
"a_key": "",
|
|
},
|
|
"name": "A String", # The relative resource name of this finding. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Example:
|
|
# "organizations/123/sources/456/findings/789"
|
|
"parent": "A String", # The relative resource name of the source the finding belongs to. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# This field is immutable after creation time.
|
|
# For example:
|
|
# "organizations/123/sources/456"
|
|
"state": "A String", # The state of the finding.
|
|
"resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
|
|
# finding is for. See:
|
|
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
|
# This field is immutable after creation time.
|
|
"securityMarks": { # User specified security marks that are attached to the parent Cloud Security # 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.
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
},
|
|
"createTime": "A String", # The time at which the finding was created in Cloud SCC.
|
|
"externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
|
|
# where additional information about the finding can be found. This field is
|
|
# guaranteed to be either empty or a well formed URL.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="updateSecurityMarks">updateSecurityMarks(name, body, startTime=None, updateMask=None, x__xgafv=None)</code>
|
|
<pre>Updates security marks.
|
|
|
|
Args:
|
|
name: string, The relative resource name of the SecurityMarks. See:
|
|
https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
Examples:
|
|
"organizations/123/assets/456/securityMarks"
|
|
"organizations/123/sources/456/findings/789/securityMarks". (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # User specified security marks that are attached to the parent Cloud Security
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
}
|
|
|
|
startTime: string, 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.
|
|
updateMask: string, 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>".
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # User specified security marks that are attached to the parent Cloud Security
|
|
# Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
|
|
# SCC organization -- they can be modified and viewed by all users who have
|
|
# proper permissions on the organization.
|
|
"name": "A String", # The relative resource name of the SecurityMarks. See:
|
|
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
|
# Examples:
|
|
# "organizations/123/assets/456/securityMarks"
|
|
# "organizations/123/sources/456/findings/789/securityMarks".
|
|
"marks": { # 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)
|
|
"a_key": "A String",
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |