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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
|
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.securityProfiles.environments.html">environments()</a></code>
</p>
<p class="firstline">Returns the environments Resource.</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="#create">create(parent, body=None, securityProfileId=None, x__xgafv=None)</a></code></p>
<p class="firstline">CreateSecurityProfile create a new custom security profile.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">DeleteSecurityProfile delete a profile with all its revisions.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.</p>
<p class="toc_element">
<code><a href="#listRevisions">listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListSecurityProfileRevisions lists all the revisions of the security profile.</p>
<p class="toc_element">
<code><a href="#listRevisions_next">listRevisions_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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">UpdateSecurityProfile update the metadata of 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="create">create(parent, body=None, securityProfileId=None, x__xgafv=None)</code>
<pre>CreateSecurityProfile create a new custom security profile.
Args:
parent: string, Required. Name of organization. Format: organizations/{org} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
}
securityProfileId: string, Required. The ID to use for the SecurityProfile, which will become the final component of the action's resource name. This value should be 1-63 characters and validated by "(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)".
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>DeleteSecurityProfile delete a profile with all its revisions.
Args:
name: string, Required. Name of profile. Format: organizations/{org}/securityProfiles/{profile} (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>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.
Args:
name: string, Required. Security profile in the following format: `organizations/{org}/securityProfiles/{profile}'. Profile may optionally contain revision ID. If revision ID is not provided, the response will contain latest revision by default. Example: organizations/testOrg/securityProfiles/testProfile@5 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
Args:
parent: string, Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}` (required)
pageSize: integer, The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned.
pageToken: string, A page token, received from a previous `ListSecurityProfiles` 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 ListSecurityProfiles.
"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.
"securityProfiles": [ # List of security profiles in the organization. The profiles may be attached or unattached to any environment. This will return latest revision of each profile.
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listRevisions">listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListSecurityProfileRevisions lists all the revisions of the security profile.
Args:
name: string, Required. For a specific profile, list all the revisions. Format: `organizations/{org}/securityProfiles/{profile}` (required)
pageSize: integer, The maximum number of profile revisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned.
pageToken: string, A page token, received from a previous `ListSecurityProfileRevisions` 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 ListSecurityProfileRevisions.
"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.
"securityProfiles": [ # List of security profile revisions. The revisions may be attached or unattached to any environment.
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listRevisions_next">listRevisions_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="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>UpdateSecurityProfile update the metadata of security profile.
Args:
name: string, Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
}
updateMask: string, Required. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE Display name of the security profile.
"environments": [ # List of environments attached to security profile.
{ # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
"attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
"environment": "A String", # Output only. Name of the environment.
},
],
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
"minScore": 42, # Output only. Minimum security score that can be generated by this profile.
"name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"revisionCreateTime": "A String", # Output only. The time when revision was created.
"revisionId": "A String", # Output only. Revision ID of the security profile.
"revisionPublishTime": "A String", # Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
"revisionUpdateTime": "A String", # Output only. The time when revision was updated.
"scoringConfigs": [ # List of profile scoring configs in this revision.
{ # Security configurations to manage scoring.
"description": "A String", # Description of the config.
"scorePath": "A String", # Path of the component config used for scoring.
"title": "A String", # Title of the config.
},
],
}</pre>
</div>
</body></html>
|
