• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="securitycenter_v1beta1.html">Cloud Security Command Center API</a> . <a href="securitycenter_v1beta1.organizations.html">organizations</a> . <a href="securitycenter_v1beta1.organizations.sources.html">sources</a> . <a href="securitycenter_v1beta1.organizations.sources.findings.html">findings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(parent, body, x__xgafv=None, findingId=None)</a></code></p>
79<p class="firstline">Creates a finding. The corresponding source must exist for finding creation</p>
80<p class="toc_element">
81  <code><a href="#group">group(parent, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Filters an organization or source's findings and  groups them by their</p>
83<p class="toc_element">
84  <code><a href="#group_next">group_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87  <code><a href="#list">list(parent, orderBy=None, pageSize=None, x__xgafv=None, pageToken=None, fieldMask=None, readTime=None, filter=None)</a></code></p>
88<p class="firstline">Lists an organization or source's findings.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Creates or updates a finding. The corresponding source must exist for a</p>
95<p class="toc_element">
96  <code><a href="#setState">setState(name, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates the state of a finding.</p>
98<p class="toc_element">
99  <code><a href="#updateSecurityMarks">updateSecurityMarks(name, body, startTime=None, updateMask=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Updates security marks.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="create">create(parent, body, x__xgafv=None, findingId=None)</code>
104  <pre>Creates a finding. The corresponding source must exist for finding creation
105to succeed.
106
107Args:
108  parent: string, Resource name of the new finding's parent. Its format should be
109"organizations/[organization_id]/sources/[source_id]". (required)
110  body: object, The request body. (required)
111    The object takes the form of:
112
113{ # Cloud Security Command Center (Cloud SCC) finding.
114      #
115      # A finding is a record of assessment data (security, risk, health or privacy)
116      # ingested into Cloud SCC for presentation, notification, analysis,
117      # policy testing, and enforcement. For example, an XSS vulnerability in an
118      # App Engine application is a finding.
119    "category": "A String", # The additional taxonomy group within findings from a given source.
120        # This field is immutable after creation time.
121        # Example: "XSS_FLASH_INJECTION"
122    "eventTime": "A String", # The time at which the event took place. For example, if the finding
123        # represents an open firewall it would capture the time the detector believes
124        # the firewall became open. The accuracy is determined by the detector.
125    "sourceProperties": { # Source specific properties. These properties are managed by the source
126        # that writes the finding. The key names in the source_properties map must be
127        # between 1 and 255 characters, and must start with a letter and contain
128        # alphanumeric characters or underscores only.
129      "a_key": "",
130    },
131    "name": "A String", # The relative resource name of this finding. See:
132        # https://cloud.google.com/apis/design/resource_names#relative_resource_name
133        # Example:
134        # "organizations/123/sources/456/findings/789"
135    "parent": "A String", # The relative resource name of the source the finding belongs to. See:
136        # https://cloud.google.com/apis/design/resource_names#relative_resource_name
137        # This field is immutable after creation time.
138        # For example:
139        # "organizations/123/sources/456"
140    "state": "A String", # The state of the finding.
141    "resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
142        # finding is for. See:
143        # https://cloud.google.com/apis/design/resource_names#full_resource_name
144        # This field is immutable after creation time.
145    "securityMarks": { # User specified security marks that are attached to the parent Cloud Security # Output only. User specified security marks. These marks are entirely
146        # managed by the user and come from the SecurityMarks resource that belongs
147        # to the finding.
148          # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
149          # SCC organization -- they can be modified and viewed by all users who have
150          # proper permissions on the organization.
151        "name": "A String", # The relative resource name of the SecurityMarks. See:
152            # https://cloud.google.com/apis/design/resource_names#relative_resource_name
153            # Examples:
154            # "organizations/123/assets/456/securityMarks"
155            # "organizations/123/sources/456/findings/789/securityMarks".
156        "marks": { # Mutable user specified security marks belonging to the parent resource.
157            # Constraints are as follows:
158            #   - Keys and values are treated as case insensitive
159            #   - Keys must be between 1 - 256 characters (inclusive)
160            #   - Keys must be letters, numbers, underscores, or dashes
161            #   - Values have leading and trailing whitespace trimmed, remaining
162            #     characters must be between 1 - 4096 characters (inclusive)
163          "a_key": "A String",
164        },
165      },
166    "createTime": "A String", # The time at which the finding was created in Cloud SCC.
167    "externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
168        # where additional information about the finding can be found. This field is
169        # guaranteed to be either empty or a well formed URL.
170  }
171
172  x__xgafv: string, V1 error format.
173    Allowed values
174      1 - v1 error format
175      2 - v2 error format
176  findingId: string, Unique identifier provided by the client within the parent scope.
177It must be alphanumeric and less than or equal to 32 characters and
178greater than 0 characters in length.
179
180Returns:
181  An object of the form:
182
183    { # Cloud Security Command Center (Cloud SCC) finding.
184        #
185        # A finding is a record of assessment data (security, risk, health or privacy)
186        # ingested into Cloud SCC for presentation, notification, analysis,
187        # policy testing, and enforcement. For example, an XSS vulnerability in an
188        # App Engine application is a finding.
189      "category": "A String", # The additional taxonomy group within findings from a given source.
190          # This field is immutable after creation time.
191          # Example: "XSS_FLASH_INJECTION"
192      "eventTime": "A String", # The time at which the event took place. For example, if the finding
193          # represents an open firewall it would capture the time the detector believes
194          # the firewall became open. The accuracy is determined by the detector.
195      "sourceProperties": { # Source specific properties. These properties are managed by the source
196          # that writes the finding. The key names in the source_properties map must be
197          # between 1 and 255 characters, and must start with a letter and contain
198          # alphanumeric characters or underscores only.
199        "a_key": "",
200      },
201      "name": "A String", # The relative resource name of this finding. See:
202          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
203          # Example:
204          # "organizations/123/sources/456/findings/789"
205      "parent": "A String", # The relative resource name of the source the finding belongs to. See:
206          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
207          # This field is immutable after creation time.
208          # For example:
209          # "organizations/123/sources/456"
210      "state": "A String", # The state of the finding.
211      "resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
212          # finding is for. See:
213          # https://cloud.google.com/apis/design/resource_names#full_resource_name
214          # This field is immutable after creation time.
215      "securityMarks": { # User specified security marks that are attached to the parent Cloud Security # Output only. User specified security marks. These marks are entirely
216          # managed by the user and come from the SecurityMarks resource that belongs
217          # to the finding.
218            # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
219            # SCC organization -- they can be modified and viewed by all users who have
220            # proper permissions on the organization.
221          "name": "A String", # The relative resource name of the SecurityMarks. See:
222              # https://cloud.google.com/apis/design/resource_names#relative_resource_name
223              # Examples:
224              # "organizations/123/assets/456/securityMarks"
225              # "organizations/123/sources/456/findings/789/securityMarks".
226          "marks": { # Mutable user specified security marks belonging to the parent resource.
227              # Constraints are as follows:
228              #   - Keys and values are treated as case insensitive
229              #   - Keys must be between 1 - 256 characters (inclusive)
230              #   - Keys must be letters, numbers, underscores, or dashes
231              #   - Values have leading and trailing whitespace trimmed, remaining
232              #     characters must be between 1 - 4096 characters (inclusive)
233            "a_key": "A String",
234          },
235        },
236      "createTime": "A String", # The time at which the finding was created in Cloud SCC.
237      "externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
238          # where additional information about the finding can be found. This field is
239          # guaranteed to be either empty or a well formed URL.
240    }</pre>
241</div>
242
243<div class="method">
244    <code class="details" id="group">group(parent, body, x__xgafv=None)</code>
245  <pre>Filters an organization or source's findings and  groups them by their
246specified properties.
247
248To group across all sources provide a `-` as the source id.
249Example: /v1beta1/organizations/123/sources/-/findings
250
251Args:
252  parent: string, Name of the source to groupBy. Its format is
253"organizations/[organization_id]/sources/[source_id]". To groupBy across
254all sources provide a source_id of `-`. For example:
255organizations/123/sources/- (required)
256  body: object, The request body. (required)
257    The object takes the form of:
258
259{ # Request message for grouping by findings.
260    "filter": "A String", # Expression that defines the filter to apply across findings.
261        # The expression is a list of one or more restrictions combined via logical
262        # operators `AND` and `OR`.
263        # Parentheses are not supported, and `OR` has higher precedence than `AND`.
264        #
265        # Restrictions have the form `<field> <operator> <value>` and may have a `-`
266        # character in front of them to indicate negation. Examples include:
267        #
268        #  * name
269        #  * source_properties.a_property
270        #  * security_marks.marks.marka
271        #
272        # The supported operators are:
273        #
274        # * `=` for all value types.
275        # * `>`, `<`, `>=`, `<=` for integer values.
276        # * `:`, meaning substring matching, for strings.
277        #
278        # The supported value types are:
279        #
280        # * string literals in quotes.
281        # * integer literals without quotes.
282        # * boolean literals `true` and `false` without quotes.
283        #
284        # For example, `source_properties.size = 100` is a valid filter string.
285    "pageToken": "A String", # The value returned by the last `GroupFindingsResponse`; indicates
286        # that this is a continuation of a prior `GroupFindings` call, and
287        # that the system should return the next page of data.
288    "groupBy": "A String", # Expression that defines what assets fields to use for grouping (including
289        # `state`). The string value should follow SQL syntax: comma separated list
290        # of fields. For example:
291        # "parent,resource_name".
292        #
293        # The following fields are supported:
294        #
295        # * resource_name
296        # * category
297        # * state
298        # * parent
299    "pageSize": 42, # The maximum number of results to return in a single response. Default is
300        # 10, minimum is 1, maximum is 1000.
301    "readTime": "A String", # Time used as a reference point when filtering findings. The filter is
302        # limited to findings existing at the supplied time and their values are
303        # those at that specific time. Absence of this field will default to the
304        # API's version of NOW.
305  }
306
307  x__xgafv: string, V1 error format.
308    Allowed values
309      1 - v1 error format
310      2 - v2 error format
311
312Returns:
313  An object of the form:
314
315    { # Response message for group by findings.
316    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
317        # results.
318    "groupByResults": [ # Group results. There exists an element for each existing unique
319        # combination of property/values. The element contains a count for the number
320        # of times those specific property/values appear.
321      { # Result containing the properties and count of a groupBy request.
322        "count": "A String", # Total count of resources for the given properties.
323        "properties": { # Properties matching the groupBy fields in the request.
324          "a_key": "",
325        },
326      },
327    ],
328    "readTime": "A String", # Time used for executing the groupBy request.
329  }</pre>
330</div>
331
332<div class="method">
333    <code class="details" id="group_next">group_next(previous_request, previous_response)</code>
334  <pre>Retrieves the next page of results.
335
336Args:
337  previous_request: The request for the previous page. (required)
338  previous_response: The response from the request for the previous page. (required)
339
340Returns:
341  A request object that you can call 'execute()' on to request the next
342  page. Returns None if there are no more items in the collection.
343    </pre>
344</div>
345
346<div class="method">
347    <code class="details" id="list">list(parent, orderBy=None, pageSize=None, x__xgafv=None, pageToken=None, fieldMask=None, readTime=None, filter=None)</code>
348  <pre>Lists an organization or source's findings.
349
350To list across all sources provide a `-` as the source id.
351Example: /v1beta1/organizations/123/sources/-/findings
352
353Args:
354  parent: string, Name of the source the findings belong to. Its format is
355"organizations/[organization_id]/sources/[source_id]". To list across all
356sources provide a source_id of `-`. For example:
357organizations/123/sources/- (required)
358  orderBy: string, Expression that defines what fields and order to use for sorting. The
359string value should follow SQL syntax: comma separated list of fields. For
360example: "name,resource_properties.a_property". The default sorting order
361is ascending. To specify descending order for a field, a suffix " desc"
362should be appended to the field name. For example: "name
363desc,source_properties.a_property". Redundant space characters in the
364syntax are insignificant. "name desc,source_properties.a_property" and "
365name     desc  ,   source_properties.a_property  " are equivalent.
366  pageSize: integer, The maximum number of results to return in a single response. Default is
36710, minimum is 1, maximum is 1000.
368  x__xgafv: string, V1 error format.
369    Allowed values
370      1 - v1 error format
371      2 - v2 error format
372  pageToken: string, The value returned by the last `ListFindingsResponse`; indicates
373that this is a continuation of a prior `ListFindings` call, and
374that the system should return the next page of data.
375  fieldMask: string, Optional.
376
377A field mask to specify the Finding fields to be listed in the response.
378An empty field mask will list all fields.
379  readTime: string, Time used as a reference point when filtering findings. The filter is
380limited to findings existing at the supplied time and their values are
381those at that specific time. Absence of this field will default to the
382API's version of NOW.
383  filter: string, Expression that defines the filter to apply across findings.
384The expression is a list of one or more restrictions combined via logical
385operators `AND` and `OR`.
386Parentheses are not supported, and `OR` has higher precedence than `AND`.
387
388Restrictions have the form `<field> <operator> <value>` and may have a `-`
389character in front of them to indicate negation. Examples include:
390
391 * name
392 * source_properties.a_property
393 * security_marks.marks.marka
394
395The supported operators are:
396
397* `=` for all value types.
398* `>`, `<`, `>=`, `<=` for integer values.
399* `:`, meaning substring matching, for strings.
400
401The supported value types are:
402
403* string literals in quotes.
404* integer literals without quotes.
405* boolean literals `true` and `false` without quotes.
406
407For example, `source_properties.size = 100` is a valid filter string.
408
409Returns:
410  An object of the form:
411
412    { # Response message for listing findings.
413    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
414        # results.
415    "totalSize": 42, # The total number of findings matching the query.
416    "findings": [ # Findings matching the list request.
417      { # Cloud Security Command Center (Cloud SCC) finding.
418            #
419            # A finding is a record of assessment data (security, risk, health or privacy)
420            # ingested into Cloud SCC for presentation, notification, analysis,
421            # policy testing, and enforcement. For example, an XSS vulnerability in an
422            # App Engine application is a finding.
423          "category": "A String", # The additional taxonomy group within findings from a given source.
424              # This field is immutable after creation time.
425              # Example: "XSS_FLASH_INJECTION"
426          "eventTime": "A String", # The time at which the event took place. For example, if the finding
427              # represents an open firewall it would capture the time the detector believes
428              # the firewall became open. The accuracy is determined by the detector.
429          "sourceProperties": { # Source specific properties. These properties are managed by the source
430              # that writes the finding. The key names in the source_properties map must be
431              # between 1 and 255 characters, and must start with a letter and contain
432              # alphanumeric characters or underscores only.
433            "a_key": "",
434          },
435          "name": "A String", # The relative resource name of this finding. See:
436              # https://cloud.google.com/apis/design/resource_names#relative_resource_name
437              # Example:
438              # "organizations/123/sources/456/findings/789"
439          "parent": "A String", # The relative resource name of the source the finding belongs to. See:
440              # https://cloud.google.com/apis/design/resource_names#relative_resource_name
441              # This field is immutable after creation time.
442              # For example:
443              # "organizations/123/sources/456"
444          "state": "A String", # The state of the finding.
445          "resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
446              # finding is for. See:
447              # https://cloud.google.com/apis/design/resource_names#full_resource_name
448              # This field is immutable after creation time.
449          "securityMarks": { # User specified security marks that are attached to the parent Cloud Security # Output only. User specified security marks. These marks are entirely
450              # managed by the user and come from the SecurityMarks resource that belongs
451              # to the finding.
452                # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
453                # SCC organization -- they can be modified and viewed by all users who have
454                # proper permissions on the organization.
455              "name": "A String", # The relative resource name of the SecurityMarks. See:
456                  # https://cloud.google.com/apis/design/resource_names#relative_resource_name
457                  # Examples:
458                  # "organizations/123/assets/456/securityMarks"
459                  # "organizations/123/sources/456/findings/789/securityMarks".
460              "marks": { # Mutable user specified security marks belonging to the parent resource.
461                  # Constraints are as follows:
462                  #   - Keys and values are treated as case insensitive
463                  #   - Keys must be between 1 - 256 characters (inclusive)
464                  #   - Keys must be letters, numbers, underscores, or dashes
465                  #   - Values have leading and trailing whitespace trimmed, remaining
466                  #     characters must be between 1 - 4096 characters (inclusive)
467                "a_key": "A String",
468              },
469            },
470          "createTime": "A String", # The time at which the finding was created in Cloud SCC.
471          "externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
472              # where additional information about the finding can be found. This field is
473              # guaranteed to be either empty or a well formed URL.
474        },
475    ],
476    "readTime": "A String", # Time used for executing the list request.
477  }</pre>
478</div>
479
480<div class="method">
481    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
482  <pre>Retrieves the next page of results.
483
484Args:
485  previous_request: The request for the previous page. (required)
486  previous_response: The response from the request for the previous page. (required)
487
488Returns:
489  A request object that you can call 'execute()' on to request the next
490  page. Returns None if there are no more items in the collection.
491    </pre>
492</div>
493
494<div class="method">
495    <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
496  <pre>Creates or updates a finding. The corresponding source must exist for a
497finding creation to succeed.
498
499Args:
500  name: string, The relative resource name of this finding. See:
501https://cloud.google.com/apis/design/resource_names#relative_resource_name
502Example:
503"organizations/123/sources/456/findings/789" (required)
504  body: object, The request body. (required)
505    The object takes the form of:
506
507{ # Cloud Security Command Center (Cloud SCC) finding.
508      #
509      # A finding is a record of assessment data (security, risk, health or privacy)
510      # ingested into Cloud SCC for presentation, notification, analysis,
511      # policy testing, and enforcement. For example, an XSS vulnerability in an
512      # App Engine application is a finding.
513    "category": "A String", # The additional taxonomy group within findings from a given source.
514        # This field is immutable after creation time.
515        # Example: "XSS_FLASH_INJECTION"
516    "eventTime": "A String", # The time at which the event took place. For example, if the finding
517        # represents an open firewall it would capture the time the detector believes
518        # the firewall became open. The accuracy is determined by the detector.
519    "sourceProperties": { # Source specific properties. These properties are managed by the source
520        # that writes the finding. The key names in the source_properties map must be
521        # between 1 and 255 characters, and must start with a letter and contain
522        # alphanumeric characters or underscores only.
523      "a_key": "",
524    },
525    "name": "A String", # The relative resource name of this finding. See:
526        # https://cloud.google.com/apis/design/resource_names#relative_resource_name
527        # Example:
528        # "organizations/123/sources/456/findings/789"
529    "parent": "A String", # The relative resource name of the source the finding belongs to. See:
530        # https://cloud.google.com/apis/design/resource_names#relative_resource_name
531        # This field is immutable after creation time.
532        # For example:
533        # "organizations/123/sources/456"
534    "state": "A String", # The state of the finding.
535    "resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
536        # finding is for. See:
537        # https://cloud.google.com/apis/design/resource_names#full_resource_name
538        # This field is immutable after creation time.
539    "securityMarks": { # User specified security marks that are attached to the parent Cloud Security # Output only. User specified security marks. These marks are entirely
540        # managed by the user and come from the SecurityMarks resource that belongs
541        # to the finding.
542          # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
543          # SCC organization -- they can be modified and viewed by all users who have
544          # proper permissions on the organization.
545        "name": "A String", # The relative resource name of the SecurityMarks. See:
546            # https://cloud.google.com/apis/design/resource_names#relative_resource_name
547            # Examples:
548            # "organizations/123/assets/456/securityMarks"
549            # "organizations/123/sources/456/findings/789/securityMarks".
550        "marks": { # Mutable user specified security marks belonging to the parent resource.
551            # Constraints are as follows:
552            #   - Keys and values are treated as case insensitive
553            #   - Keys must be between 1 - 256 characters (inclusive)
554            #   - Keys must be letters, numbers, underscores, or dashes
555            #   - Values have leading and trailing whitespace trimmed, remaining
556            #     characters must be between 1 - 4096 characters (inclusive)
557          "a_key": "A String",
558        },
559      },
560    "createTime": "A String", # The time at which the finding was created in Cloud SCC.
561    "externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
562        # where additional information about the finding can be found. This field is
563        # guaranteed to be either empty or a well formed URL.
564  }
565
566  updateMask: string, The FieldMask to use when updating the finding resource. This field should
567not be specified when creating a finding.
568  x__xgafv: string, V1 error format.
569    Allowed values
570      1 - v1 error format
571      2 - v2 error format
572
573Returns:
574  An object of the form:
575
576    { # Cloud Security Command Center (Cloud SCC) finding.
577        #
578        # A finding is a record of assessment data (security, risk, health or privacy)
579        # ingested into Cloud SCC for presentation, notification, analysis,
580        # policy testing, and enforcement. For example, an XSS vulnerability in an
581        # App Engine application is a finding.
582      "category": "A String", # The additional taxonomy group within findings from a given source.
583          # This field is immutable after creation time.
584          # Example: "XSS_FLASH_INJECTION"
585      "eventTime": "A String", # The time at which the event took place. For example, if the finding
586          # represents an open firewall it would capture the time the detector believes
587          # the firewall became open. The accuracy is determined by the detector.
588      "sourceProperties": { # Source specific properties. These properties are managed by the source
589          # that writes the finding. The key names in the source_properties map must be
590          # between 1 and 255 characters, and must start with a letter and contain
591          # alphanumeric characters or underscores only.
592        "a_key": "",
593      },
594      "name": "A String", # The relative resource name of this finding. See:
595          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
596          # Example:
597          # "organizations/123/sources/456/findings/789"
598      "parent": "A String", # The relative resource name of the source the finding belongs to. See:
599          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
600          # This field is immutable after creation time.
601          # For example:
602          # "organizations/123/sources/456"
603      "state": "A String", # The state of the finding.
604      "resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
605          # finding is for. See:
606          # https://cloud.google.com/apis/design/resource_names#full_resource_name
607          # This field is immutable after creation time.
608      "securityMarks": { # User specified security marks that are attached to the parent Cloud Security # Output only. User specified security marks. These marks are entirely
609          # managed by the user and come from the SecurityMarks resource that belongs
610          # to the finding.
611            # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
612            # SCC organization -- they can be modified and viewed by all users who have
613            # proper permissions on the organization.
614          "name": "A String", # The relative resource name of the SecurityMarks. See:
615              # https://cloud.google.com/apis/design/resource_names#relative_resource_name
616              # Examples:
617              # "organizations/123/assets/456/securityMarks"
618              # "organizations/123/sources/456/findings/789/securityMarks".
619          "marks": { # Mutable user specified security marks belonging to the parent resource.
620              # Constraints are as follows:
621              #   - Keys and values are treated as case insensitive
622              #   - Keys must be between 1 - 256 characters (inclusive)
623              #   - Keys must be letters, numbers, underscores, or dashes
624              #   - Values have leading and trailing whitespace trimmed, remaining
625              #     characters must be between 1 - 4096 characters (inclusive)
626            "a_key": "A String",
627          },
628        },
629      "createTime": "A String", # The time at which the finding was created in Cloud SCC.
630      "externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
631          # where additional information about the finding can be found. This field is
632          # guaranteed to be either empty or a well formed URL.
633    }</pre>
634</div>
635
636<div class="method">
637    <code class="details" id="setState">setState(name, body, x__xgafv=None)</code>
638  <pre>Updates the state of a finding.
639
640Args:
641  name: string, The relative resource name of the finding. See:
642https://cloud.google.com/apis/design/resource_names#relative_resource_name
643Example:
644"organizations/123/sources/456/finding/789". (required)
645  body: object, The request body. (required)
646    The object takes the form of:
647
648{ # Request message for updating a finding's state.
649    "state": "A String", # The desired State of the finding.
650    "startTime": "A String", # The time at which the updated state takes effect.
651  }
652
653  x__xgafv: string, V1 error format.
654    Allowed values
655      1 - v1 error format
656      2 - v2 error format
657
658Returns:
659  An object of the form:
660
661    { # Cloud Security Command Center (Cloud SCC) finding.
662        #
663        # A finding is a record of assessment data (security, risk, health or privacy)
664        # ingested into Cloud SCC for presentation, notification, analysis,
665        # policy testing, and enforcement. For example, an XSS vulnerability in an
666        # App Engine application is a finding.
667      "category": "A String", # The additional taxonomy group within findings from a given source.
668          # This field is immutable after creation time.
669          # Example: "XSS_FLASH_INJECTION"
670      "eventTime": "A String", # The time at which the event took place. For example, if the finding
671          # represents an open firewall it would capture the time the detector believes
672          # the firewall became open. The accuracy is determined by the detector.
673      "sourceProperties": { # Source specific properties. These properties are managed by the source
674          # that writes the finding. The key names in the source_properties map must be
675          # between 1 and 255 characters, and must start with a letter and contain
676          # alphanumeric characters or underscores only.
677        "a_key": "",
678      },
679      "name": "A String", # The relative resource name of this finding. See:
680          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
681          # Example:
682          # "organizations/123/sources/456/findings/789"
683      "parent": "A String", # The relative resource name of the source the finding belongs to. See:
684          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
685          # This field is immutable after creation time.
686          # For example:
687          # "organizations/123/sources/456"
688      "state": "A String", # The state of the finding.
689      "resourceName": "A String", # The full resource name of the Google Cloud Platform (GCP) resource this
690          # finding is for. See:
691          # https://cloud.google.com/apis/design/resource_names#full_resource_name
692          # This field is immutable after creation time.
693      "securityMarks": { # User specified security marks that are attached to the parent Cloud Security # Output only. User specified security marks. These marks are entirely
694          # managed by the user and come from the SecurityMarks resource that belongs
695          # to the finding.
696            # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
697            # SCC organization -- they can be modified and viewed by all users who have
698            # proper permissions on the organization.
699          "name": "A String", # The relative resource name of the SecurityMarks. See:
700              # https://cloud.google.com/apis/design/resource_names#relative_resource_name
701              # Examples:
702              # "organizations/123/assets/456/securityMarks"
703              # "organizations/123/sources/456/findings/789/securityMarks".
704          "marks": { # Mutable user specified security marks belonging to the parent resource.
705              # Constraints are as follows:
706              #   - Keys and values are treated as case insensitive
707              #   - Keys must be between 1 - 256 characters (inclusive)
708              #   - Keys must be letters, numbers, underscores, or dashes
709              #   - Values have leading and trailing whitespace trimmed, remaining
710              #     characters must be between 1 - 4096 characters (inclusive)
711            "a_key": "A String",
712          },
713        },
714      "createTime": "A String", # The time at which the finding was created in Cloud SCC.
715      "externalUri": "A String", # The URI that, if available, points to a web page outside of Cloud SCC
716          # where additional information about the finding can be found. This field is
717          # guaranteed to be either empty or a well formed URL.
718    }</pre>
719</div>
720
721<div class="method">
722    <code class="details" id="updateSecurityMarks">updateSecurityMarks(name, body, startTime=None, updateMask=None, x__xgafv=None)</code>
723  <pre>Updates security marks.
724
725Args:
726  name: string, The relative resource name of the SecurityMarks. See:
727https://cloud.google.com/apis/design/resource_names#relative_resource_name
728Examples:
729"organizations/123/assets/456/securityMarks"
730"organizations/123/sources/456/findings/789/securityMarks". (required)
731  body: object, The request body. (required)
732    The object takes the form of:
733
734{ # User specified security marks that are attached to the parent Cloud Security
735      # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
736      # SCC organization -- they can be modified and viewed by all users who have
737      # proper permissions on the organization.
738    "name": "A String", # The relative resource name of the SecurityMarks. See:
739        # https://cloud.google.com/apis/design/resource_names#relative_resource_name
740        # Examples:
741        # "organizations/123/assets/456/securityMarks"
742        # "organizations/123/sources/456/findings/789/securityMarks".
743    "marks": { # Mutable user specified security marks belonging to the parent resource.
744        # Constraints are as follows:
745        #   - Keys and values are treated as case insensitive
746        #   - Keys must be between 1 - 256 characters (inclusive)
747        #   - Keys must be letters, numbers, underscores, or dashes
748        #   - Values have leading and trailing whitespace trimmed, remaining
749        #     characters must be between 1 - 4096 characters (inclusive)
750      "a_key": "A String",
751    },
752  }
753
754  startTime: string, The time at which the updated SecurityMarks take effect.
755  updateMask: string, The FieldMask to use when updating the security marks resource.
756  x__xgafv: string, V1 error format.
757    Allowed values
758      1 - v1 error format
759      2 - v2 error format
760
761Returns:
762  An object of the form:
763
764    { # User specified security marks that are attached to the parent Cloud Security
765        # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud
766        # SCC organization -- they can be modified and viewed by all users who have
767        # proper permissions on the organization.
768      "name": "A String", # The relative resource name of the SecurityMarks. See:
769          # https://cloud.google.com/apis/design/resource_names#relative_resource_name
770          # Examples:
771          # "organizations/123/assets/456/securityMarks"
772          # "organizations/123/sources/456/findings/789/securityMarks".
773      "marks": { # Mutable user specified security marks belonging to the parent resource.
774          # Constraints are as follows:
775          #   - Keys and values are treated as case insensitive
776          #   - Keys must be between 1 - 256 characters (inclusive)
777          #   - Keys must be letters, numbers, underscores, or dashes
778          #   - Values have leading and trailing whitespace trimmed, remaining
779          #     characters must be between 1 - 4096 characters (inclusive)
780        "a_key": "A String",
781      },
782    }</pre>
783</div>
784
785</body></html>