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
|
<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.securityProfiles.html">securityProfiles</a> . <a href="apigee_v1.organizations.securityProfiles.environments.html">environments</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="#computeEnvironmentScores">computeEnvironmentScores(profileEnvironment, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.</p>
<p class="toc_element">
<code><a href="#computeEnvironmentScores_next">computeEnvironmentScores_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">DeleteSecurityProfileEnvironmentAssociation removes profile environment association i.e. detaches environment from security profile.</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="computeEnvironmentScores">computeEnvironmentScores(profileEnvironment, body=None, x__xgafv=None)</code>
<pre>ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.
Args:
profileEnvironment: string, Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/{org}/securityProfiles/{profile}/environments/{env} (required)
body: object, The request body.
The object takes the form of:
{ # Request for ComputeEnvironmentScores.
"filters": [ # Optional. Filters are used to filter scored components. Return all the components if no filter is mentioned. Example: [{ "scorePath": "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" }, { "scorePath": "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", }] This will return components with path: "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" OR "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target"
{ # Filter scores by component path. Used custom filter instead of AIP-160 as the use cases are highly constrained and predictable.
"scorePath": "A String", # Optional. Return scores for this component. Example: "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source"
},
],
"pageSize": 42, # Optional. The maximum number of subcomponents to be returned in a single page. The service may return fewer than this value. If unspecified, at most 100 subcomponents will be returned in a single page.
"pageToken": "A String", # Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Required. Time range for score calculation. At most 14 days of scores will be returned, and both the start and end dates must be within the last 90 days.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ComputeEnvironmentScores.
"nextPageToken": "A String", # A page token, received from a previous `ComputeScore` call. Provide this to retrieve the subsequent page.
"scores": [ # List of scores. One score per day.
{ # Represents Security Score.
"component": { # Component is an individual security element that is scored. # Component containing score, recommendations and actions.
"calculateTime": "A String", # Time when score was calculated.
"dataCaptureTime": "A String", # Time in the requested time period when data was last captured to compute the score.
"drilldownPaths": [ # List of paths for next components.
"A String",
],
"recommendations": [ # List of recommendations to improve API security.
{ # Recommendation based on security concerns and score.
"actions": [ # Actions for the recommendation to improve the security score.
{ # Action to improve security score.
"actionContext": { # Action context are all the relevant details for the action. # Action context for the action.
"documentationLink": "A String", # Documentation link for the action.
},
"description": "A String", # Description of the action.
},
],
"description": "A String", # Description of the recommendation.
"impact": 42, # Potential impact of this recommendation on the overall score. This denotes how important this recommendation is to improve the score.
"title": "A String", # Title represents recommendation title.
},
],
"score": 42, # Score for the component.
"scorePath": "A String", # Path of the component. Example: /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy
},
"subcomponents": [ # List of all the drilldown score components.
{ # Component is an individual security element that is scored.
"calculateTime": "A String", # Time when score was calculated.
"dataCaptureTime": "A String", # Time in the requested time period when data was last captured to compute the score.
"drilldownPaths": [ # List of paths for next components.
"A String",
],
"recommendations": [ # List of recommendations to improve API security.
{ # Recommendation based on security concerns and score.
"actions": [ # Actions for the recommendation to improve the security score.
{ # Action to improve security score.
"actionContext": { # Action context are all the relevant details for the action. # Action context for the action.
"documentationLink": "A String", # Documentation link for the action.
},
"description": "A String", # Description of the action.
},
],
"description": "A String", # Description of the recommendation.
"impact": 42, # Potential impact of this recommendation on the overall score. This denotes how important this recommendation is to improve the score.
"title": "A String", # Title represents recommendation title.
},
],
"score": 42, # Score for the component.
"scorePath": "A String", # Path of the component. Example: /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy
},
],
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Start and end time for the score.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="computeEnvironmentScores_next">computeEnvironmentScores_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="create">create(parent, body=None, x__xgafv=None)</code>
<pre>CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.
Args:
parent: string, Required. Name of organization and security profile ID. Format: organizations/{org}/securityProfiles/{profile} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a SecurityProfileEnvironmentAssociation resource.
"attachTime": "A String", # Output only. The time when environment was attached to the security profile.
"name": "A String", # Immutable. Name of the environment that the profile is attached to.
"securityProfileRevisionId": "A String", # DEPRECATED: DO NOT USE Revision ID of the security profile.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a SecurityProfileEnvironmentAssociation resource.
"attachTime": "A String", # Output only. The time when environment was attached to the security profile.
"name": "A String", # Immutable. Name of the environment that the profile is attached to.
"securityProfileRevisionId": "A String", # DEPRECATED: DO NOT USE Revision ID of the security profile.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>DeleteSecurityProfileEnvironmentAssociation removes profile environment association i.e. detaches environment from security profile.
Args:
name: string, Required. The name of the environment attachment to delete. Format: organizations/{org}/securityProfiles/{profile}/environments/{env} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
</body></html>
|
