1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
<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="securityposture_v1.html">Security Posture API</a> . <a href="securityposture_v1.organizations.html">organizations</a> . <a href="securityposture_v1.organizations.locations.html">locations</a> . <a href="securityposture_v1.organizations.locations.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#createIaCValidationReport">createIaCValidationReport(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Validates a specified infrastructure-as-code (IaC) configuration, and creates a Report with the validation results. Only Terraform configurations are supported. Only modified assets are validated.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details for a Report.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists every Report in a given organization and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="createIaCValidationReport">createIaCValidationReport(parent, body=None, x__xgafv=None)</code>
<pre>Validates a specified infrastructure-as-code (IaC) configuration, and creates a Report with the validation results. Only Terraform configurations are supported. Only modified assets are validated.
Args:
parent: string, Required. The parent resource name, in the format `organizations/{organization}/locations/global`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CreateIaCValidationReport.
"iac": { # Details of an infrastructure-as-code (IaC) configuration. # Required. The infrastructure-as-code (IaC) configuration to validate.
"tfPlan": "A String", # Optional. A Terraform plan file, formatted as a stringified JSON object. To learn how to generate a Terraform plan file in JSON format, see [JSON output format](https://developer.hashicorp.com/terraform/internals/json-format) in the Terraform documentation.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details for a Report.
Args:
name: string, Required. The name of the report, in the format `organizations/{organization}/locations/global/reports/{report_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of a report.
"createTime": "A String", # Output only. The time at which the report was created.
"iacValidationReport": { # Details of an infrastructure-as-code (IaC) validation report. # Output only. An infrastructure-as-code (IaC) validation report.
"note": "A String", # Additional information about the report.
"violations": [ # A list of every Violation found in the IaC configuration.
{ # Details of a violation.
"assetId": "A String", # The full resource name of the asset that caused the violation. For details about the format of the full resource name for each asset type, see [Resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format).
"nextSteps": "A String", # A description of the steps that you can take to fix the violation.
"policyId": "A String", # The policy that was violated.
"severity": "A String", # The severity of the violation.
"violatedAsset": { # Details of a Cloud Asset Inventory asset that caused a violation. # Details of the Cloud Asset Inventory asset that caused the violation.
"asset": "A String", # Information about the Cloud Asset Inventory asset that violated a policy. The format of this information can change at any time without prior notice. Your application must not depend on this information in any way.
"assetType": "A String", # The type of Cloud Asset Inventory asset. For a list of asset types, see [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
},
"violatedPolicy": { # Details of a policy that was violated. # Details of the policy that was violated.
"complianceStandards": [ # The compliance standards that the policy maps to. For example, `CIS-2.0 1.15`.
"A String",
],
"constraint": "A String", # Information about the constraint that was violated. The format of this information can change at any time without prior notice. Your application must not depend on this information in any way.
"constraintType": "A String", # The type of constraint that was violated.
"description": "A String", # A description of the policy.
},
"violatedPosture": { # Details of a posture deployment. # Details for the posture that was violated. This field is present only if the violated policy belongs to a deployed posture.
"policySet": "A String", # The identifier for the PolicySet that the relevant policy belongs to.
"posture": "A String", # The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
"postureDeployment": "A String", # The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
"postureDeploymentTargetResource": "A String", # The organization, folder, or project where the posture is deployed. Uses one of the following formats: * `organizations/{organization_number}` * `folders/{folder_number}` * `projects/{project_number}`
"postureRevisionId": "A String", # The revision ID of the posture used in the deployment.
},
},
],
},
"name": "A String", # Required. The name of the report, in the format `organizations/{organization}/locations/global/reports/{report_id}`.
"updateTime": "A String", # Output only. The time at which the report was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists every Report in a given organization and location.
Args:
parent: string, Required. The parent resource name, in the format `organizations/{organization}/locations/global`. (required)
filter: string, Optional. A filter to apply to the list of reports, in the format defined in [AIP-160: Filtering](https://google.aip.dev/160).
pageSize: integer, Optional. The maximum number of reports to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
pageToken: string, Optional. A pagination token returned from a previous request to list reports. Provide this token to retrieve the next page of results.
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 ListReports.
"nextPageToken": "A String", # A pagination token. To retrieve the next page of results, call the method again with this token.
"reports": [ # The list of Report resources.
{ # Details of a report.
"createTime": "A String", # Output only. The time at which the report was created.
"iacValidationReport": { # Details of an infrastructure-as-code (IaC) validation report. # Output only. An infrastructure-as-code (IaC) validation report.
"note": "A String", # Additional information about the report.
"violations": [ # A list of every Violation found in the IaC configuration.
{ # Details of a violation.
"assetId": "A String", # The full resource name of the asset that caused the violation. For details about the format of the full resource name for each asset type, see [Resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format).
"nextSteps": "A String", # A description of the steps that you can take to fix the violation.
"policyId": "A String", # The policy that was violated.
"severity": "A String", # The severity of the violation.
"violatedAsset": { # Details of a Cloud Asset Inventory asset that caused a violation. # Details of the Cloud Asset Inventory asset that caused the violation.
"asset": "A String", # Information about the Cloud Asset Inventory asset that violated a policy. The format of this information can change at any time without prior notice. Your application must not depend on this information in any way.
"assetType": "A String", # The type of Cloud Asset Inventory asset. For a list of asset types, see [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
},
"violatedPolicy": { # Details of a policy that was violated. # Details of the policy that was violated.
"complianceStandards": [ # The compliance standards that the policy maps to. For example, `CIS-2.0 1.15`.
"A String",
],
"constraint": "A String", # Information about the constraint that was violated. The format of this information can change at any time without prior notice. Your application must not depend on this information in any way.
"constraintType": "A String", # The type of constraint that was violated.
"description": "A String", # A description of the policy.
},
"violatedPosture": { # Details of a posture deployment. # Details for the posture that was violated. This field is present only if the violated policy belongs to a deployed posture.
"policySet": "A String", # The identifier for the PolicySet that the relevant policy belongs to.
"posture": "A String", # The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
"postureDeployment": "A String", # The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
"postureDeploymentTargetResource": "A String", # The organization, folder, or project where the posture is deployed. Uses one of the following formats: * `organizations/{organization_number}` * `folders/{folder_number}` * `projects/{project_number}`
"postureRevisionId": "A String", # The revision ID of the posture used in the deployment.
},
},
],
},
"name": "A String", # Required. The name of the report, in the format `organizations/{organization}/locations/global/reports/{report_id}`.
"updateTime": "A String", # Output only. The time at which the report was last updated.
},
],
"unreachable": [ # Locations that were temporarily unavailable and could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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>
</body></html>
|
