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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
<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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.securityIncidents.html">securityIncidents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">BatchUpdateSecurityIncident updates multiple existing security incidents.</p>
<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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.</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">ListSecurityIncidents lists all the security incident associated with the environment.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">UpdateSecurityIncidents updates an existing security incident.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
<pre>BatchUpdateSecurityIncident updates multiple existing security incidents.
Args:
parent: string, Optional. The parent resource shared by all security incidents being updated. If this is set, the parent field in the UpdateSecurityIncidentRequest messages must either be empty or match this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request for BatchUpdateSecurityIncident.
"requests": [ # Optional. Required. The request message specifying the resources to update. A maximum of 1000 can be modified in a batch.
{ # Request for UpdateSecurityIncident.
"securityIncident": { # Represents an SecurityIncident resource. # Required. The security incident to update. Must contain all existing populated fields of the current incident.
"detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
"A String",
],
"displayName": "A String", # Optional. Display name of the security incident.
"firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
"lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
"lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
"name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
"observability": "A String", # Optional. Indicates if the user archived this incident.
"riskLevel": "A String", # Output only. Risk level of the incident.
"trafficCount": "A String", # Total traffic detected as part of the incident.
},
"updateMask": "A String", # Required. The list of fields to update. Allowed fields are: LINT.IfChange(allowed_update_fields_comment) - observability LINT.ThenChange()
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for BatchUpdateSecurityIncident.
"securityIncidents": [ # Output only. Updated security incidents
{ # Represents an SecurityIncident resource.
"detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
"A String",
],
"displayName": "A String", # Optional. Display name of the security incident.
"firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
"lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
"lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
"name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
"observability": "A String", # Optional. Indicates if the user archived this incident.
"riskLevel": "A String", # Output only. Risk level of the incident.
"trafficCount": "A String", # Total traffic detected as part of the incident.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.
Args:
name: string, Required. Security incident in the following format: `organizations/{org}/environments/{environment}/securityIncidents/{incident}'. Example: organizations/testOrg/environments/testEnv/securityIncidents/1234-4567-890-111 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an SecurityIncident resource.
"detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
"A String",
],
"displayName": "A String", # Optional. Display name of the security incident.
"firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
"lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
"lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
"name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
"observability": "A String", # Optional. Indicates if the user archived this incident.
"riskLevel": "A String", # Output only. Risk level of the incident.
"trafficCount": "A String", # Total traffic detected as part of the incident.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListSecurityIncidents lists all the security incident associated with the environment.
Args:
parent: string, Required. For a specific organization, list of all the security incidents. Format: `organizations/{org}/environments/{environment}` (required)
filter: string, The filter expression to be used to get the list of security incidents, where filtering can be done on API Proxies. Example: filter = "api_proxy = /", "first_detected_time >", "last_detected_time <"
pageSize: integer, Optional. The maximum number of incidents to return. The service may return fewer than this value. If unspecified, at most 50 incidents will be returned.
pageToken: string, Optional. A page token, received from a previous `ListSecurityIncident` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListSecurityIncidents.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"securityIncidents": [ # List of security incidents in the organization
{ # Represents an SecurityIncident resource.
"detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
"A String",
],
"displayName": "A String", # Optional. Display name of the security incident.
"firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
"lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
"lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
"name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
"observability": "A String", # Optional. Indicates if the user archived this incident.
"riskLevel": "A String", # Output only. Risk level of the incident.
"trafficCount": "A String", # Total traffic detected as part of the incident.
},
],
}</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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>UpdateSecurityIncidents updates an existing security incident.
Args:
name: string, Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 (required)
body: object, The request body.
The object takes the form of:
{ # Represents an SecurityIncident resource.
"detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
"A String",
],
"displayName": "A String", # Optional. Display name of the security incident.
"firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
"lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
"lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
"name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
"observability": "A String", # Optional. Indicates if the user archived this incident.
"riskLevel": "A String", # Output only. Risk level of the incident.
"trafficCount": "A String", # Total traffic detected as part of the incident.
}
updateMask: string, Required. The list of fields to update. Allowed fields are: LINT.IfChange(allowed_update_fields_comment) - observability LINT.ThenChange()
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an SecurityIncident resource.
"detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
"A String",
],
"displayName": "A String", # Optional. Display name of the security incident.
"firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
"lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
"lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
"name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
"observability": "A String", # Optional. Indicates if the user archived this incident.
"riskLevel": "A String", # Output only. Risk level of the incident.
"trafficCount": "A String", # Total traffic detected as part of the incident.
}</pre>
</div>
</body></html>
|
