blob: 1fbc365b704c74d77f7865ea59dfad2393d092e5 [file] [log] [blame]
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001<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_v1.html">Security Command Center API</a> . <a href="securitycenter_v1.folders.html">folders</a> . <a href="securitycenter_v1.folders.sources.html">sources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="securitycenter_v1.folders.sources.findings.html">findings()</a></code>
79</p>
80<p class="firstline">Returns the findings Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080086 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080087<p class="firstline">Lists all sources belonging to an organization.</p>
88<p class="toc_element">
89 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
93 <code class="details" id="close">close()</code>
94 <pre>Close httplib2 connections.</pre>
95</div>
96
97<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080098 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080099 <pre>Lists all sources belonging to an organization.
100
101Args:
102 parent: string, Required. Resource name of the parent of sources to list. Its format should be &quot;organizations/[organization_id], folders/[folder_id], or projects/[project_id]&quot;. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800103 pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800104 pageToken: string, 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110Returns:
111 An object of the form:
112
113 { # Response message for listing sources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800114 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results.
115 &quot;sources&quot;: [ # Sources belonging to the requested parent.
116 { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400117 &quot;canonicalName&quot;: &quot;A String&quot;, # The canonical name of the finding. It&#x27;s either &quot;organizations/{organization_id}/sources/{source_id}&quot;, &quot;folders/{folder_id}/sources/{source_id}&quot; or &quot;projects/{project_number}/sources/{source_id}&quot;, depending on the closest CRM ancestor of the resource associated with the finding.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800118 &quot;description&quot;: &quot;A String&quot;, # The description of the source (max of 1024 characters). Example: &quot;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.&quot;
119 &quot;displayName&quot;: &quot;A String&quot;, # The source&#x27;s display name. A source&#x27;s display name must be unique amongst its siblings, for example, two sources with the same parent can&#x27;t share the same display name. The display name must have a length between 1 and 64 characters (inclusive).
120 &quot;name&quot;: &quot;A String&quot;, # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: &quot;organizations/{organization_id}/sources/{source_id}&quot;
121 },
122 ],
123}</pre>
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800124</div>
125
126<div class="method">
127 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
128 <pre>Retrieves the next page of results.
129
130Args:
131 previous_request: The request for the previous page. (required)
132 previous_response: The response from the request for the previous page. (required)
133
134Returns:
135 A request object that you can call &#x27;execute()&#x27; on to request the next
136 page. Returns None if there are no more items in the collection.
137 </pre>
138</div>
139
140</body></html>