@maxim_mazurok/gapi.client.websecurityscanner-v1beta 0.0.20231112 → 0.0.20231130

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -9,1128 +9,781 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://websecurityscanner.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20231112
12
+ // Revision: 20231130
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Web Security Scanner API v1beta */
18
- function load(urlOrObject: "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1beta"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "websecurityscanner", version: "v1beta"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "websecurityscanner", version: "v1beta", callback: () => any): void;
17
+ /** Load Web Security Scanner API v1beta */
18
+ function load(
19
+ urlOrObject: 'https://websecurityscanner.googleapis.com/$discovery/rest?version=v1beta'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'websecurityscanner', version: 'v1beta'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(
25
+ name: 'websecurityscanner',
26
+ version: 'v1beta',
27
+ callback: () => any
28
+ ): void;
23
29
 
24
- namespace websecurityscanner {
25
- interface Authentication {
26
- /** Authentication using a custom account. */
27
- customAccount?:
28
- CustomAccount;
29
- /** Authentication using a Google account. */
30
- googleAccount?:
31
- GoogleAccount;
32
- /** Authentication using Identity-Aware-Proxy (IAP). */
33
- iapCredential?:
34
- IapCredential;
35
- }
36
- interface CrawledUrl {
37
- /** The body of the request that was used to visit the URL. */
38
- body?:
39
- string;
40
- /** The http method of the request that was used to visit the URL, in uppercase. */
41
- httpMethod?:
42
- string;
43
- /** The URL that was crawled. */
44
- url?:
45
- string;
46
- }
47
- interface CustomAccount {
48
- /** Required. The login form URL of the website. */
49
- loginUrl?:
50
- string;
51
- /** Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */
52
- password?:
53
- string;
54
- /** Required. The user name of the custom account. */
55
- username?:
56
- string;
57
- }
58
- // tslint:disable-next-line:no-empty-interface
59
- interface Empty {
60
- }
61
- interface Finding {
62
- /** The body of the request that triggered the vulnerability. */
63
- body?:
64
- string;
65
- /** The description of the vulnerability. */
66
- description?:
67
- string;
68
- /** The URL where the browser lands when the vulnerability is detected. */
69
- finalUrl?:
70
- string;
71
- /**
72
- * The type of the Finding. Detailed and up-to-date information on findings can be found here:
73
- * https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner
74
- */
75
- findingType?:
76
- string;
77
- /** An addon containing information reported for a vulnerability with an HTML form, if any. */
78
- form?:
79
- Form;
80
- /** If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */
81
- frameUrl?:
82
- string;
83
- /** The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */
84
- fuzzedUrl?:
85
- string;
86
- /** The http method of the request that triggered the vulnerability, in uppercase. */
87
- httpMethod?:
88
- string;
89
- /**
90
- * The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are
91
- * generated by the system.
92
- */
93
- name?:
94
- string;
95
- /** An addon containing information about outdated libraries. */
96
- outdatedLibrary?:
97
- OutdatedLibrary;
98
- /** The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */
99
- reproductionUrl?:
100
- string;
101
- /** The severity level of the reported vulnerability. */
102
- severity?:
103
- string;
104
- /** The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */
105
- trackingId?:
106
- string;
107
- /** An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */
108
- violatingResource?:
109
- ViolatingResource;
110
- /** An addon containing information about vulnerable or missing HTTP headers. */
111
- vulnerableHeaders?:
112
- VulnerableHeaders;
113
- /** An addon containing information about request parameters which were found to be vulnerable. */
114
- vulnerableParameters?:
115
- VulnerableParameters;
116
- /** An addon containing information reported for an XSS, if any. */
117
- xss?:
118
- Xss;
119
- /** An addon containing information reported for an XXE, if any. */
120
- xxe?:
121
- Xxe;
122
- }
123
- interface FindingTypeStats {
124
- /** The count of findings belonging to this finding type. */
125
- findingCount?:
126
- number;
127
- /** The finding type associated with the stats. */
128
- findingType?:
129
- string;
130
- }
131
- interface Form {
132
- /** ! The URI where to send the form when it's submitted. */
133
- actionUri?:
134
- string;
135
- /** ! The names of form fields related to the vulnerability. */
136
- fields?:
137
- string[];
138
- }
139
- interface GoogleAccount {
140
- /** Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */
141
- password?:
142
- string;
143
- /** Required. The user name of the Google account. */
144
- username?:
145
- string;
146
- }
147
- interface Header {
148
- /** Header name. */
149
- name?:
150
- string;
151
- /** Header value. */
152
- value?:
153
- string;
154
- }
155
- interface IapCredential {
156
- /** Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. */
157
- iapTestServiceAccountInfo?:
158
- IapTestServiceAccountInfo;
159
- }
160
- interface IapTestServiceAccountInfo {
161
- /** Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP). */
162
- targetAudienceClientId?:
163
- string;
164
- }
165
- interface ListCrawledUrlsResponse {
166
- /** The list of CrawledUrls returned. */
167
- crawledUrls?:
168
- CrawledUrl[];
169
- /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
170
- nextPageToken?:
171
- string;
172
- }
173
- interface ListFindingsResponse {
174
- /** The list of Findings returned. */
175
- findings?:
176
- Finding[];
177
- /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
178
- nextPageToken?:
179
- string;
180
- }
181
- interface ListFindingTypeStatsResponse {
182
- /** The list of FindingTypeStats returned. */
183
- findingTypeStats?:
184
- FindingTypeStats[];
185
- }
186
- interface ListScanConfigsResponse {
187
- /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
188
- nextPageToken?:
189
- string;
190
- /** The list of ScanConfigs returned. */
191
- scanConfigs?:
192
- ScanConfig[];
193
- }
194
- interface ListScanRunsResponse {
195
- /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
196
- nextPageToken?:
197
- string;
198
- /** The list of ScanRuns returned. */
199
- scanRuns?:
200
- ScanRun[];
201
- }
202
- interface OutdatedLibrary {
203
- /** URLs to learn more information about the vulnerabilities in the library. */
204
- learnMoreUrls?:
205
- string[];
206
- /** The name of the outdated library. */
207
- libraryName?:
208
- string;
209
- /** The version number. */
210
- version?:
211
- string;
212
- }
213
- interface ScanConfig {
214
- /** The authentication configuration. If specified, service will use the authentication configuration during scanning. */
215
- authentication?:
216
- Authentication;
217
- /** The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls */
218
- blacklistPatterns?:
219
- string[];
220
- /** Required. The user provided display name of the ScanConfig. */
221
- displayName?:
222
- string;
223
- /** Controls export of scan configurations and results to Security Command Center. */
224
- exportToSecurityCommandCenter?:
225
- string;
226
- /** Whether to keep scanning even if most requests return HTTP error codes. */
227
- ignoreHttpStatusErrors?:
228
- boolean;
229
- /** Latest ScanRun if available. */
230
- latestRun?:
231
- ScanRun;
232
- /** Whether the scan config is managed by Web Security Scanner, output only. */
233
- managedScan?:
234
- boolean;
235
- /**
236
- * The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of
237
- * [5, 20] range will be rejected with INVALID_ARGUMENT error.
238
- */
239
- maxQps?:
240
- number;
241
- /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
242
- name?:
243
- string;
244
- /** The risk level selected for the scan */
245
- riskLevel?:
246
- string;
247
- /** The schedule of the ScanConfig. */
248
- schedule?:
249
- Schedule;
250
- /** Required. The starting URLs from which the scanner finds site pages. */
251
- startingUrls?:
252
- string[];
253
- /** Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. */
254
- staticIpScan?:
255
- boolean;
256
- /** Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */
257
- targetPlatforms?:
258
- string[];
259
- /** The user agent used during scanning. */
260
- userAgent?:
261
- string;
262
- }
263
- interface ScanConfigError {
264
- /** Indicates the reason code for a configuration failure. */
265
- code?:
266
- string;
267
- /**
268
- * Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual
269
- * value can change in the future.
270
- */
271
- fieldName?:
272
- string;
273
- }
274
- interface ScanRun {
275
- /** The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */
276
- endTime?:
277
- string;
278
- /** If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */
279
- errorTrace?:
280
- ScanRunErrorTrace;
281
- /** The execution state of the ScanRun. */
282
- executionState?:
283
- string;
284
- /** Whether the scan run has found any vulnerabilities. */
285
- hasVulnerabilities?:
286
- boolean;
287
- /** The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */
288
- name?:
289
- string;
290
- /**
291
- * The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished,
292
- * the value is 100.
293
- */
294
- progressPercent?:
295
- number;
296
- /** The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */
297
- resultState?:
298
- string;
299
- /** The time at which the ScanRun started. */
300
- startTime?:
301
- string;
302
- /** The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */
303
- urlsCrawledCount?:
304
- string;
305
- /**
306
- * The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than
307
- * the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
308
- */
309
- urlsTestedCount?:
310
- string;
311
- /** A list of warnings, if such are encountered during this scan run. */
312
- warningTraces?:
313
- ScanRunWarningTrace[];
314
- }
315
- interface ScanRunErrorTrace {
316
- /** Indicates the error reason code. */
317
- code?:
318
- string;
319
- /**
320
- * If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered
321
- * too many NOT_FOUND responses.
322
- */
323
- mostCommonHttpErrorCode?:
324
- number;
325
- /** If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */
326
- scanConfigError?:
327
- ScanConfigError;
328
- }
329
- interface ScanRunWarningTrace {
330
- /** Indicates the warning code. */
331
- code?:
332
- string;
333
- }
334
- interface Schedule {
335
- /** Required. The duration of time between executions in days. */
336
- intervalDurationDays?:
337
- number;
338
- /**
339
- * A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means
340
- * the scan will be scheduled to start immediately.
341
- */
342
- scheduleTime?:
343
- string;
344
- }
345
- // tslint:disable-next-line:no-empty-interface
346
- interface StartScanRunRequest {
347
- }
348
- // tslint:disable-next-line:no-empty-interface
349
- interface StopScanRunRequest {
350
- }
351
- interface ViolatingResource {
352
- /** The MIME type of this resource. */
353
- contentType?:
354
- string;
355
- /** URL of this violating resource. */
356
- resourceUrl?:
357
- string;
358
- }
359
- interface VulnerableHeaders {
360
- /** List of vulnerable headers. */
361
- headers?:
362
- Header[];
363
- /** List of missing headers. */
364
- missingHeaders?:
365
- Header[];
366
- }
367
- interface VulnerableParameters {
368
- /** The vulnerable parameter names. */
369
- parameterNames?:
370
- string[];
371
- }
372
- interface Xss {
373
- /** An error message generated by a javascript breakage. */
374
- errorMessage?:
375
- string;
376
- /** Stack traces leading to the point where the XSS occurred. */
377
- stackTraces?:
378
- string[];
379
- }
380
- interface Xxe {
381
- /** Location within the request where the payload was placed. */
382
- payloadLocation?:
383
- string;
384
- /** The XML string that triggered the XXE vulnerability. Non-payload values might be redacted. */
385
- payloadValue?:
386
- string;
387
- }
388
- interface CrawledUrlsResource {
389
- /** List CrawledUrls under a given ScanRun. */
390
- list(request?: {
391
- /** V1 error format. */
392
- "$.xgafv"?:
393
- string;
394
- /** OAuth access token. */
395
- access_token?:
396
- string;
397
- /** Data format for response. */
398
- alt?:
399
- string;
400
- /** JSONP */
401
- callback?:
402
- string;
403
- /** Selector specifying which fields to include in a partial response. */
404
- fields?:
405
- string;
406
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
407
- key?:
408
- string;
409
- /** OAuth 2.0 token for the current user. */
410
- oauth_token?:
411
- string;
412
- /** The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
413
- pageSize?:
414
- number;
415
- /**
416
- * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results
417
- * is returned.
418
- */
419
- pageToken?:
420
- string;
421
- /** Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
422
- parent:
423
- string;
424
- /** Returns response with indentations and line breaks. */
425
- prettyPrint?:
426
- boolean;
427
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
428
- quotaUser?:
429
- string;
430
- /** Upload protocol for media (e.g. "raw", "multipart"). */
431
- upload_protocol?:
432
- string;
433
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
434
- uploadType?:
435
- string;
436
- }): Request<ListCrawledUrlsResponse>;
437
- }
438
- interface FindingsResource {
439
- /** Gets a Finding. */
440
- get(request?: {
441
- /** V1 error format. */
442
- "$.xgafv"?:
443
- string;
444
- /** OAuth access token. */
445
- access_token?:
446
- string;
447
- /** Data format for response. */
448
- alt?:
449
- string;
450
- /** JSONP */
451
- callback?:
452
- string;
453
- /** Selector specifying which fields to include in a partial response. */
454
- fields?:
455
- string;
456
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
457
- key?:
458
- string;
459
- /**
460
- * Required. The resource name of the Finding to be returned. The name follows the format of
461
- * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.
462
- */
463
- name:
464
- string;
465
- /** OAuth 2.0 token for the current user. */
466
- oauth_token?:
467
- string;
468
- /** Returns response with indentations and line breaks. */
469
- prettyPrint?:
470
- boolean;
471
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
472
- quotaUser?:
473
- string;
474
- /** Upload protocol for media (e.g. "raw", "multipart"). */
475
- upload_protocol?:
476
- string;
477
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
478
- uploadType?:
479
- string;
480
- }): Request<Finding>;
481
- /** List Findings under a given ScanRun. */
482
- list(request?: {
483
- /** V1 error format. */
484
- "$.xgafv"?:
485
- string;
486
- /** OAuth access token. */
487
- access_token?:
488
- string;
489
- /** Data format for response. */
490
- alt?:
491
- string;
492
- /** JSONP */
493
- callback?:
494
- string;
495
- /** Selector specifying which fields to include in a partial response. */
496
- fields?:
497
- string;
498
- /** Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */
499
- filter?:
500
- string;
501
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
502
- key?:
503
- string;
504
- /** OAuth 2.0 token for the current user. */
505
- oauth_token?:
506
- string;
507
- /** The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
508
- pageSize?:
509
- number;
510
- /**
511
- * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results
512
- * is returned.
513
- */
514
- pageToken?:
515
- string;
516
- /** Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
517
- parent:
518
- string;
519
- /** Returns response with indentations and line breaks. */
520
- prettyPrint?:
521
- boolean;
522
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
523
- quotaUser?:
524
- string;
525
- /** Upload protocol for media (e.g. "raw", "multipart"). */
526
- upload_protocol?:
527
- string;
528
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
529
- uploadType?:
530
- string;
531
- }): Request<ListFindingsResponse>;
532
- }
533
- interface FindingTypeStatsResource {
534
- /** List all FindingTypeStats under a given ScanRun. */
535
- list(request?: {
536
- /** V1 error format. */
537
- "$.xgafv"?:
538
- string;
539
- /** OAuth access token. */
540
- access_token?:
541
- string;
542
- /** Data format for response. */
543
- alt?:
544
- string;
545
- /** JSONP */
546
- callback?:
547
- string;
548
- /** Selector specifying which fields to include in a partial response. */
549
- fields?:
550
- string;
551
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
552
- key?:
553
- string;
554
- /** OAuth 2.0 token for the current user. */
555
- oauth_token?:
556
- string;
557
- /** Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
558
- parent:
559
- string;
560
- /** Returns response with indentations and line breaks. */
561
- prettyPrint?:
562
- boolean;
563
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
564
- quotaUser?:
565
- string;
566
- /** Upload protocol for media (e.g. "raw", "multipart"). */
567
- upload_protocol?:
568
- string;
569
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
570
- uploadType?:
571
- string;
572
- }): Request<ListFindingTypeStatsResponse>;
573
- }
574
- interface ScanRunsResource {
575
- /** Gets a ScanRun. */
576
- get(request?: {
577
- /** V1 error format. */
578
- "$.xgafv"?:
579
- string;
580
- /** OAuth access token. */
581
- access_token?:
582
- string;
583
- /** Data format for response. */
584
- alt?:
585
- string;
586
- /** JSONP */
587
- callback?:
588
- string;
589
- /** Selector specifying which fields to include in a partial response. */
590
- fields?:
591
- string;
592
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
593
- key?:
594
- string;
595
- /** Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
596
- name:
597
- string;
598
- /** OAuth 2.0 token for the current user. */
599
- oauth_token?:
600
- string;
601
- /** Returns response with indentations and line breaks. */
602
- prettyPrint?:
603
- boolean;
604
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
605
- quotaUser?:
606
- string;
607
- /** Upload protocol for media (e.g. "raw", "multipart"). */
608
- upload_protocol?:
609
- string;
610
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
611
- uploadType?:
612
- string;
613
- }): Request<ScanRun>;
614
- /** Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. */
615
- list(request?: {
616
- /** V1 error format. */
617
- "$.xgafv"?:
618
- string;
619
- /** OAuth access token. */
620
- access_token?:
621
- string;
622
- /** Data format for response. */
623
- alt?:
624
- string;
625
- /** JSONP */
626
- callback?:
627
- string;
628
- /** Selector specifying which fields to include in a partial response. */
629
- fields?:
630
- string;
631
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
632
- key?:
633
- string;
634
- /** OAuth 2.0 token for the current user. */
635
- oauth_token?:
636
- string;
637
- /** The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
638
- pageSize?:
639
- number;
640
- /**
641
- * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results
642
- * is returned.
643
- */
644
- pageToken?:
645
- string;
646
- /** Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
647
- parent:
648
- string;
649
- /** Returns response with indentations and line breaks. */
650
- prettyPrint?:
651
- boolean;
652
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
653
- quotaUser?:
654
- string;
655
- /** Upload protocol for media (e.g. "raw", "multipart"). */
656
- upload_protocol?:
657
- string;
658
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
659
- uploadType?:
660
- string;
661
- }): Request<ListScanRunsResponse>;
662
- /** Stops a ScanRun. The stopped ScanRun is returned. */
663
- stop(request: {
664
- /** V1 error format. */
665
- "$.xgafv"?:
666
- string;
667
- /** OAuth access token. */
668
- access_token?:
669
- string;
670
- /** Data format for response. */
671
- alt?:
672
- string;
673
- /** JSONP */
674
- callback?:
675
- string;
676
- /** Selector specifying which fields to include in a partial response. */
677
- fields?:
678
- string;
679
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
680
- key?:
681
- string;
682
- /** Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
683
- name:
684
- string;
685
- /** OAuth 2.0 token for the current user. */
686
- oauth_token?:
687
- string;
688
- /** Returns response with indentations and line breaks. */
689
- prettyPrint?:
690
- boolean;
691
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
692
- quotaUser?:
693
- string;
694
- /** Upload protocol for media (e.g. "raw", "multipart"). */
695
- upload_protocol?:
696
- string;
697
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
698
- uploadType?:
699
- string;
700
- /** Request body */
701
- resource:
702
- StopScanRunRequest;
703
- }): Request<ScanRun>;
704
- stop(request: {
705
- /** V1 error format. */
706
- "$.xgafv"?:
707
- string;
708
- /** OAuth access token. */
709
- access_token?:
710
- string;
711
- /** Data format for response. */
712
- alt?:
713
- string;
714
- /** JSONP */
715
- callback?:
716
- string;
717
- /** Selector specifying which fields to include in a partial response. */
718
- fields?:
719
- string;
720
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
721
- key?:
722
- string;
723
- /** Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
724
- name:
725
- string;
726
- /** OAuth 2.0 token for the current user. */
727
- oauth_token?:
728
- string;
729
- /** Returns response with indentations and line breaks. */
730
- prettyPrint?:
731
- boolean;
732
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
733
- quotaUser?:
734
- string;
735
- /** Upload protocol for media (e.g. "raw", "multipart"). */
736
- upload_protocol?:
737
- string;
738
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
739
- uploadType?:
740
- string;
741
- },
742
- body: StopScanRunRequest): Request<ScanRun>;
743
- crawledUrls:
744
- CrawledUrlsResource;
745
- findings:
746
- FindingsResource;
747
- findingTypeStats:
748
- FindingTypeStatsResource;
749
- }
750
- interface ScanConfigsResource {
751
- /** Creates a new ScanConfig. */
752
- create(request: {
753
- /** V1 error format. */
754
- "$.xgafv"?:
755
- string;
756
- /** OAuth access token. */
757
- access_token?:
758
- string;
759
- /** Data format for response. */
760
- alt?:
761
- string;
762
- /** JSONP */
763
- callback?:
764
- string;
765
- /** Selector specifying which fields to include in a partial response. */
766
- fields?:
767
- string;
768
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
769
- key?:
770
- string;
771
- /** OAuth 2.0 token for the current user. */
772
- oauth_token?:
773
- string;
774
- /** Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. */
775
- parent:
776
- string;
777
- /** Returns response with indentations and line breaks. */
778
- prettyPrint?:
779
- boolean;
780
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
781
- quotaUser?:
782
- string;
783
- /** Upload protocol for media (e.g. "raw", "multipart"). */
784
- upload_protocol?:
785
- string;
786
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
787
- uploadType?:
788
- string;
789
- /** Request body */
790
- resource:
791
- ScanConfig;
792
- }): Request<ScanConfig>;
793
- create(request: {
794
- /** V1 error format. */
795
- "$.xgafv"?:
796
- string;
797
- /** OAuth access token. */
798
- access_token?:
799
- string;
800
- /** Data format for response. */
801
- alt?:
802
- string;
803
- /** JSONP */
804
- callback?:
805
- string;
806
- /** Selector specifying which fields to include in a partial response. */
807
- fields?:
808
- string;
809
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
810
- key?:
811
- string;
812
- /** OAuth 2.0 token for the current user. */
813
- oauth_token?:
814
- string;
815
- /** Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. */
816
- parent:
817
- string;
818
- /** Returns response with indentations and line breaks. */
819
- prettyPrint?:
820
- boolean;
821
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
822
- quotaUser?:
823
- string;
824
- /** Upload protocol for media (e.g. "raw", "multipart"). */
825
- upload_protocol?:
826
- string;
827
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
828
- uploadType?:
829
- string;
830
- },
831
- body: ScanConfig): Request<ScanConfig>;
832
- /** Deletes an existing ScanConfig and its child resources. */
833
- delete(request?: {
834
- /** V1 error format. */
835
- "$.xgafv"?:
836
- string;
837
- /** OAuth access token. */
838
- access_token?:
839
- string;
840
- /** Data format for response. */
841
- alt?:
842
- string;
843
- /** JSONP */
844
- callback?:
845
- string;
846
- /** Selector specifying which fields to include in a partial response. */
847
- fields?:
848
- string;
849
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
850
- key?:
851
- string;
852
- /** Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
853
- name:
854
- string;
855
- /** OAuth 2.0 token for the current user. */
856
- oauth_token?:
857
- string;
858
- /** Returns response with indentations and line breaks. */
859
- prettyPrint?:
860
- boolean;
861
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
862
- quotaUser?:
863
- string;
864
- /** Upload protocol for media (e.g. "raw", "multipart"). */
865
- upload_protocol?:
866
- string;
867
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
868
- uploadType?:
869
- string;
870
- }): Request<{}>;
871
- /** Gets a ScanConfig. */
872
- get(request?: {
873
- /** V1 error format. */
874
- "$.xgafv"?:
875
- string;
876
- /** OAuth access token. */
877
- access_token?:
878
- string;
879
- /** Data format for response. */
880
- alt?:
881
- string;
882
- /** JSONP */
883
- callback?:
884
- string;
885
- /** Selector specifying which fields to include in a partial response. */
886
- fields?:
887
- string;
888
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
889
- key?:
890
- string;
891
- /** Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
892
- name:
893
- string;
894
- /** OAuth 2.0 token for the current user. */
895
- oauth_token?:
896
- string;
897
- /** Returns response with indentations and line breaks. */
898
- prettyPrint?:
899
- boolean;
900
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
901
- quotaUser?:
902
- string;
903
- /** Upload protocol for media (e.g. "raw", "multipart"). */
904
- upload_protocol?:
905
- string;
906
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
907
- uploadType?:
908
- string;
909
- }): Request<ScanConfig>;
910
- /** Lists ScanConfigs under a given project. */
911
- list(request?: {
912
- /** V1 error format. */
913
- "$.xgafv"?:
914
- string;
915
- /** OAuth access token. */
916
- access_token?:
917
- string;
918
- /** Data format for response. */
919
- alt?:
920
- string;
921
- /** JSONP */
922
- callback?:
923
- string;
924
- /** Selector specifying which fields to include in a partial response. */
925
- fields?:
926
- string;
927
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
928
- key?:
929
- string;
930
- /** OAuth 2.0 token for the current user. */
931
- oauth_token?:
932
- string;
933
- /** The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
934
- pageSize?:
935
- number;
936
- /**
937
- * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results
938
- * is returned.
939
- */
940
- pageToken?:
941
- string;
942
- /** Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. */
943
- parent:
944
- string;
945
- /** Returns response with indentations and line breaks. */
946
- prettyPrint?:
947
- boolean;
948
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
949
- quotaUser?:
950
- string;
951
- /** Upload protocol for media (e.g. "raw", "multipart"). */
952
- upload_protocol?:
953
- string;
954
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
955
- uploadType?:
956
- string;
957
- }): Request<ListScanConfigsResponse>;
958
- /** Updates a ScanConfig. This method support partial update of a ScanConfig. */
959
- patch(request: {
960
- /** V1 error format. */
961
- "$.xgafv"?:
962
- string;
963
- /** OAuth access token. */
964
- access_token?:
965
- string;
966
- /** Data format for response. */
967
- alt?:
968
- string;
969
- /** JSONP */
970
- callback?:
971
- string;
972
- /** Selector specifying which fields to include in a partial response. */
973
- fields?:
974
- string;
975
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
976
- key?:
977
- string;
978
- /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
979
- name:
980
- string;
981
- /** OAuth 2.0 token for the current user. */
982
- oauth_token?:
983
- string;
984
- /** Returns response with indentations and line breaks. */
985
- prettyPrint?:
986
- boolean;
987
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
988
- quotaUser?:
989
- string;
990
- /** Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */
991
- updateMask?:
992
- string;
993
- /** Upload protocol for media (e.g. "raw", "multipart"). */
994
- upload_protocol?:
995
- string;
996
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
997
- uploadType?:
998
- string;
999
- /** Request body */
1000
- resource:
1001
- ScanConfig;
1002
- }): Request<ScanConfig>;
1003
- patch(request: {
1004
- /** V1 error format. */
1005
- "$.xgafv"?:
1006
- string;
1007
- /** OAuth access token. */
1008
- access_token?:
1009
- string;
1010
- /** Data format for response. */
1011
- alt?:
1012
- string;
1013
- /** JSONP */
1014
- callback?:
1015
- string;
1016
- /** Selector specifying which fields to include in a partial response. */
1017
- fields?:
1018
- string;
1019
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1020
- key?:
1021
- string;
1022
- /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
1023
- name:
1024
- string;
1025
- /** OAuth 2.0 token for the current user. */
1026
- oauth_token?:
1027
- string;
1028
- /** Returns response with indentations and line breaks. */
1029
- prettyPrint?:
1030
- boolean;
1031
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1032
- quotaUser?:
1033
- string;
1034
- /** Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */
1035
- updateMask?:
1036
- string;
1037
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1038
- upload_protocol?:
1039
- string;
1040
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1041
- uploadType?:
1042
- string;
1043
- },
1044
- body: ScanConfig): Request<ScanConfig>;
1045
- /** Start a ScanRun according to the given ScanConfig. */
1046
- start(request: {
1047
- /** V1 error format. */
1048
- "$.xgafv"?:
1049
- string;
1050
- /** OAuth access token. */
1051
- access_token?:
1052
- string;
1053
- /** Data format for response. */
1054
- alt?:
1055
- string;
1056
- /** JSONP */
1057
- callback?:
1058
- string;
1059
- /** Selector specifying which fields to include in a partial response. */
1060
- fields?:
1061
- string;
1062
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1063
- key?:
1064
- string;
1065
- /** Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
1066
- name:
1067
- string;
1068
- /** OAuth 2.0 token for the current user. */
1069
- oauth_token?:
1070
- string;
1071
- /** Returns response with indentations and line breaks. */
1072
- prettyPrint?:
1073
- boolean;
1074
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1075
- quotaUser?:
1076
- string;
1077
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1078
- upload_protocol?:
1079
- string;
1080
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1081
- uploadType?:
1082
- string;
1083
- /** Request body */
1084
- resource:
1085
- StartScanRunRequest;
1086
- }): Request<ScanRun>;
1087
- start(request: {
1088
- /** V1 error format. */
1089
- "$.xgafv"?:
1090
- string;
1091
- /** OAuth access token. */
1092
- access_token?:
1093
- string;
1094
- /** Data format for response. */
1095
- alt?:
1096
- string;
1097
- /** JSONP */
1098
- callback?:
1099
- string;
1100
- /** Selector specifying which fields to include in a partial response. */
1101
- fields?:
1102
- string;
1103
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1104
- key?:
1105
- string;
1106
- /** Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
1107
- name:
1108
- string;
1109
- /** OAuth 2.0 token for the current user. */
1110
- oauth_token?:
1111
- string;
1112
- /** Returns response with indentations and line breaks. */
1113
- prettyPrint?:
1114
- boolean;
1115
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1116
- quotaUser?:
1117
- string;
1118
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1119
- upload_protocol?:
1120
- string;
1121
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1122
- uploadType?:
1123
- string;
1124
- },
1125
- body: StartScanRunRequest): Request<ScanRun>;
1126
- scanRuns:
1127
- ScanRunsResource;
1128
- }
1129
- interface ProjectsResource {
1130
- scanConfigs:
1131
- ScanConfigsResource;
1132
- }
1133
-
1134
- const projects: ProjectsResource;
30
+ namespace websecurityscanner {
31
+ interface Authentication {
32
+ /** Authentication using a custom account. */
33
+ customAccount?: CustomAccount;
34
+ /** Authentication using a Google account. */
35
+ googleAccount?: GoogleAccount;
36
+ /** Authentication using Identity-Aware-Proxy (IAP). */
37
+ iapCredential?: IapCredential;
38
+ }
39
+ interface CrawledUrl {
40
+ /** The body of the request that was used to visit the URL. */
41
+ body?: string;
42
+ /** The http method of the request that was used to visit the URL, in uppercase. */
43
+ httpMethod?: string;
44
+ /** The URL that was crawled. */
45
+ url?: string;
46
+ }
47
+ interface CustomAccount {
48
+ /** Required. The login form URL of the website. */
49
+ loginUrl?: string;
50
+ /** Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */
51
+ password?: string;
52
+ /** Required. The user name of the custom account. */
53
+ username?: string;
54
+ }
55
+ interface Empty {}
56
+ interface Finding {
57
+ /** The body of the request that triggered the vulnerability. */
58
+ body?: string;
59
+ /** The description of the vulnerability. */
60
+ description?: string;
61
+ /** The URL where the browser lands when the vulnerability is detected. */
62
+ finalUrl?: string;
63
+ /** The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner */
64
+ findingType?: string;
65
+ /** An addon containing information reported for a vulnerability with an HTML form, if any. */
66
+ form?: Form;
67
+ /** If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */
68
+ frameUrl?: string;
69
+ /** The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */
70
+ fuzzedUrl?: string;
71
+ /** The http method of the request that triggered the vulnerability, in uppercase. */
72
+ httpMethod?: string;
73
+ /** The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */
74
+ name?: string;
75
+ /** An addon containing information about outdated libraries. */
76
+ outdatedLibrary?: OutdatedLibrary;
77
+ /** The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */
78
+ reproductionUrl?: string;
79
+ /** The severity level of the reported vulnerability. */
80
+ severity?: string;
81
+ /** The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */
82
+ trackingId?: string;
83
+ /** An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */
84
+ violatingResource?: ViolatingResource;
85
+ /** An addon containing information about vulnerable or missing HTTP headers. */
86
+ vulnerableHeaders?: VulnerableHeaders;
87
+ /** An addon containing information about request parameters which were found to be vulnerable. */
88
+ vulnerableParameters?: VulnerableParameters;
89
+ /** An addon containing information reported for an XSS, if any. */
90
+ xss?: Xss;
91
+ /** An addon containing information reported for an XXE, if any. */
92
+ xxe?: Xxe;
93
+ }
94
+ interface FindingTypeStats {
95
+ /** The count of findings belonging to this finding type. */
96
+ findingCount?: number;
97
+ /** The finding type associated with the stats. */
98
+ findingType?: string;
99
+ }
100
+ interface Form {
101
+ /** ! The URI where to send the form when it's submitted. */
102
+ actionUri?: string;
103
+ /** ! The names of form fields related to the vulnerability. */
104
+ fields?: string[];
105
+ }
106
+ interface GoogleAccount {
107
+ /** Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */
108
+ password?: string;
109
+ /** Required. The user name of the Google account. */
110
+ username?: string;
111
+ }
112
+ interface Header {
113
+ /** Header name. */
114
+ name?: string;
115
+ /** Header value. */
116
+ value?: string;
117
+ }
118
+ interface IapCredential {
119
+ /** Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. */
120
+ iapTestServiceAccountInfo?: IapTestServiceAccountInfo;
121
+ }
122
+ interface IapTestServiceAccountInfo {
123
+ /** Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP). */
124
+ targetAudienceClientId?: string;
125
+ }
126
+ interface ListCrawledUrlsResponse {
127
+ /** The list of CrawledUrls returned. */
128
+ crawledUrls?: CrawledUrl[];
129
+ /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
130
+ nextPageToken?: string;
131
+ }
132
+ interface ListFindingsResponse {
133
+ /** The list of Findings returned. */
134
+ findings?: Finding[];
135
+ /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
136
+ nextPageToken?: string;
137
+ }
138
+ interface ListFindingTypeStatsResponse {
139
+ /** The list of FindingTypeStats returned. */
140
+ findingTypeStats?: FindingTypeStats[];
141
+ }
142
+ interface ListScanConfigsResponse {
143
+ /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
144
+ nextPageToken?: string;
145
+ /** The list of ScanConfigs returned. */
146
+ scanConfigs?: ScanConfig[];
147
+ }
148
+ interface ListScanRunsResponse {
149
+ /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
150
+ nextPageToken?: string;
151
+ /** The list of ScanRuns returned. */
152
+ scanRuns?: ScanRun[];
153
+ }
154
+ interface OutdatedLibrary {
155
+ /** URLs to learn more information about the vulnerabilities in the library. */
156
+ learnMoreUrls?: string[];
157
+ /** The name of the outdated library. */
158
+ libraryName?: string;
159
+ /** The version number. */
160
+ version?: string;
161
+ }
162
+ interface ScanConfig {
163
+ /** The authentication configuration. If specified, service will use the authentication configuration during scanning. */
164
+ authentication?: Authentication;
165
+ /** The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls */
166
+ blacklistPatterns?: string[];
167
+ /** Required. The user provided display name of the ScanConfig. */
168
+ displayName?: string;
169
+ /** Controls export of scan configurations and results to Security Command Center. */
170
+ exportToSecurityCommandCenter?: string;
171
+ /** Whether to keep scanning even if most requests return HTTP error codes. */
172
+ ignoreHttpStatusErrors?: boolean;
173
+ /** Latest ScanRun if available. */
174
+ latestRun?: ScanRun;
175
+ /** Whether the scan config is managed by Web Security Scanner, output only. */
176
+ managedScan?: boolean;
177
+ /** The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. */
178
+ maxQps?: number;
179
+ /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
180
+ name?: string;
181
+ /** The risk level selected for the scan */
182
+ riskLevel?: string;
183
+ /** The schedule of the ScanConfig. */
184
+ schedule?: Schedule;
185
+ /** Required. The starting URLs from which the scanner finds site pages. */
186
+ startingUrls?: string[];
187
+ /** Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. */
188
+ staticIpScan?: boolean;
189
+ /** Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */
190
+ targetPlatforms?: string[];
191
+ /** The user agent used during scanning. */
192
+ userAgent?: string;
1135
193
  }
194
+ interface ScanConfigError {
195
+ /** Indicates the reason code for a configuration failure. */
196
+ code?: string;
197
+ /** Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. */
198
+ fieldName?: string;
199
+ }
200
+ interface ScanRun {
201
+ /** The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */
202
+ endTime?: string;
203
+ /** If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */
204
+ errorTrace?: ScanRunErrorTrace;
205
+ /** The execution state of the ScanRun. */
206
+ executionState?: string;
207
+ /** Whether the scan run has found any vulnerabilities. */
208
+ hasVulnerabilities?: boolean;
209
+ /** The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */
210
+ name?: string;
211
+ /** The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */
212
+ progressPercent?: number;
213
+ /** The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */
214
+ resultState?: string;
215
+ /** The time at which the ScanRun started. */
216
+ startTime?: string;
217
+ /** The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */
218
+ urlsCrawledCount?: string;
219
+ /** The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */
220
+ urlsTestedCount?: string;
221
+ /** A list of warnings, if such are encountered during this scan run. */
222
+ warningTraces?: ScanRunWarningTrace[];
223
+ }
224
+ interface ScanRunErrorTrace {
225
+ /** Indicates the error reason code. */
226
+ code?: string;
227
+ /** If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. */
228
+ mostCommonHttpErrorCode?: number;
229
+ /** If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */
230
+ scanConfigError?: ScanConfigError;
231
+ }
232
+ interface ScanRunWarningTrace {
233
+ /** Indicates the warning code. */
234
+ code?: string;
235
+ }
236
+ interface Schedule {
237
+ /** Required. The duration of time between executions in days. */
238
+ intervalDurationDays?: number;
239
+ /** A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. */
240
+ scheduleTime?: string;
241
+ }
242
+ interface StartScanRunRequest {}
243
+ interface StopScanRunRequest {}
244
+ interface ViolatingResource {
245
+ /** The MIME type of this resource. */
246
+ contentType?: string;
247
+ /** URL of this violating resource. */
248
+ resourceUrl?: string;
249
+ }
250
+ interface VulnerableHeaders {
251
+ /** List of vulnerable headers. */
252
+ headers?: Header[];
253
+ /** List of missing headers. */
254
+ missingHeaders?: Header[];
255
+ }
256
+ interface VulnerableParameters {
257
+ /** The vulnerable parameter names. */
258
+ parameterNames?: string[];
259
+ }
260
+ interface Xss {
261
+ /** An error message generated by a javascript breakage. */
262
+ errorMessage?: string;
263
+ /** Stack traces leading to the point where the XSS occurred. */
264
+ stackTraces?: string[];
265
+ }
266
+ interface Xxe {
267
+ /** Location within the request where the payload was placed. */
268
+ payloadLocation?: string;
269
+ /** The XML string that triggered the XXE vulnerability. Non-payload values might be redacted. */
270
+ payloadValue?: string;
271
+ }
272
+ interface CrawledUrlsResource {
273
+ /** List CrawledUrls under a given ScanRun. */
274
+ list(request?: {
275
+ /** V1 error format. */
276
+ '$.xgafv'?: string;
277
+ /** OAuth access token. */
278
+ access_token?: string;
279
+ /** Data format for response. */
280
+ alt?: string;
281
+ /** JSONP */
282
+ callback?: string;
283
+ /** Selector specifying which fields to include in a partial response. */
284
+ fields?: string;
285
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
286
+ key?: string;
287
+ /** OAuth 2.0 token for the current user. */
288
+ oauth_token?: string;
289
+ /** The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
290
+ pageSize?: number;
291
+ /** A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */
292
+ pageToken?: string;
293
+ /** Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
294
+ parent: string;
295
+ /** Returns response with indentations and line breaks. */
296
+ prettyPrint?: boolean;
297
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
298
+ quotaUser?: string;
299
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
300
+ upload_protocol?: string;
301
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
302
+ uploadType?: string;
303
+ }): Request<ListCrawledUrlsResponse>;
304
+ }
305
+ interface FindingsResource {
306
+ /** Gets a Finding. */
307
+ get(request?: {
308
+ /** V1 error format. */
309
+ '$.xgafv'?: string;
310
+ /** OAuth access token. */
311
+ access_token?: string;
312
+ /** Data format for response. */
313
+ alt?: string;
314
+ /** JSONP */
315
+ callback?: string;
316
+ /** Selector specifying which fields to include in a partial response. */
317
+ fields?: string;
318
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
319
+ key?: string;
320
+ /** Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. */
321
+ name: string;
322
+ /** OAuth 2.0 token for the current user. */
323
+ oauth_token?: string;
324
+ /** Returns response with indentations and line breaks. */
325
+ prettyPrint?: boolean;
326
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
327
+ quotaUser?: string;
328
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
329
+ upload_protocol?: string;
330
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
331
+ uploadType?: string;
332
+ }): Request<Finding>;
333
+ /** List Findings under a given ScanRun. */
334
+ list(request?: {
335
+ /** V1 error format. */
336
+ '$.xgafv'?: string;
337
+ /** OAuth access token. */
338
+ access_token?: string;
339
+ /** Data format for response. */
340
+ alt?: string;
341
+ /** JSONP */
342
+ callback?: string;
343
+ /** Selector specifying which fields to include in a partial response. */
344
+ fields?: string;
345
+ /** Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */
346
+ filter?: string;
347
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
348
+ key?: string;
349
+ /** OAuth 2.0 token for the current user. */
350
+ oauth_token?: string;
351
+ /** The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
352
+ pageSize?: number;
353
+ /** A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */
354
+ pageToken?: string;
355
+ /** Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
356
+ parent: string;
357
+ /** Returns response with indentations and line breaks. */
358
+ prettyPrint?: boolean;
359
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
360
+ quotaUser?: string;
361
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
362
+ upload_protocol?: string;
363
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
364
+ uploadType?: string;
365
+ }): Request<ListFindingsResponse>;
366
+ }
367
+ interface FindingTypeStatsResource {
368
+ /** List all FindingTypeStats under a given ScanRun. */
369
+ list(request?: {
370
+ /** V1 error format. */
371
+ '$.xgafv'?: string;
372
+ /** OAuth access token. */
373
+ access_token?: string;
374
+ /** Data format for response. */
375
+ alt?: string;
376
+ /** JSONP */
377
+ callback?: string;
378
+ /** Selector specifying which fields to include in a partial response. */
379
+ fields?: string;
380
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
381
+ key?: string;
382
+ /** OAuth 2.0 token for the current user. */
383
+ oauth_token?: string;
384
+ /** Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
385
+ parent: string;
386
+ /** Returns response with indentations and line breaks. */
387
+ prettyPrint?: boolean;
388
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
389
+ quotaUser?: string;
390
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
391
+ upload_protocol?: string;
392
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
393
+ uploadType?: string;
394
+ }): Request<ListFindingTypeStatsResponse>;
395
+ }
396
+ interface ScanRunsResource {
397
+ /** Gets a ScanRun. */
398
+ get(request?: {
399
+ /** V1 error format. */
400
+ '$.xgafv'?: string;
401
+ /** OAuth access token. */
402
+ access_token?: string;
403
+ /** Data format for response. */
404
+ alt?: string;
405
+ /** JSONP */
406
+ callback?: string;
407
+ /** Selector specifying which fields to include in a partial response. */
408
+ fields?: string;
409
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
410
+ key?: string;
411
+ /** Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
412
+ name: string;
413
+ /** OAuth 2.0 token for the current user. */
414
+ oauth_token?: string;
415
+ /** Returns response with indentations and line breaks. */
416
+ prettyPrint?: boolean;
417
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
418
+ quotaUser?: string;
419
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
420
+ upload_protocol?: string;
421
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
422
+ uploadType?: string;
423
+ }): Request<ScanRun>;
424
+ /** Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. */
425
+ list(request?: {
426
+ /** V1 error format. */
427
+ '$.xgafv'?: string;
428
+ /** OAuth access token. */
429
+ access_token?: string;
430
+ /** Data format for response. */
431
+ alt?: string;
432
+ /** JSONP */
433
+ callback?: string;
434
+ /** Selector specifying which fields to include in a partial response. */
435
+ fields?: string;
436
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
437
+ key?: string;
438
+ /** OAuth 2.0 token for the current user. */
439
+ oauth_token?: string;
440
+ /** The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
441
+ pageSize?: number;
442
+ /** A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */
443
+ pageToken?: string;
444
+ /** Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
445
+ parent: string;
446
+ /** Returns response with indentations and line breaks. */
447
+ prettyPrint?: boolean;
448
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
449
+ quotaUser?: string;
450
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
451
+ upload_protocol?: string;
452
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
453
+ uploadType?: string;
454
+ }): Request<ListScanRunsResponse>;
455
+ /** Stops a ScanRun. The stopped ScanRun is returned. */
456
+ stop(request: {
457
+ /** V1 error format. */
458
+ '$.xgafv'?: string;
459
+ /** OAuth access token. */
460
+ access_token?: string;
461
+ /** Data format for response. */
462
+ alt?: string;
463
+ /** JSONP */
464
+ callback?: string;
465
+ /** Selector specifying which fields to include in a partial response. */
466
+ fields?: string;
467
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
468
+ key?: string;
469
+ /** Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
470
+ name: string;
471
+ /** OAuth 2.0 token for the current user. */
472
+ oauth_token?: string;
473
+ /** Returns response with indentations and line breaks. */
474
+ prettyPrint?: boolean;
475
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
476
+ quotaUser?: string;
477
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
478
+ upload_protocol?: string;
479
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
480
+ uploadType?: string;
481
+ /** Request body */
482
+ resource: StopScanRunRequest;
483
+ }): Request<ScanRun>;
484
+ stop(
485
+ request: {
486
+ /** V1 error format. */
487
+ '$.xgafv'?: string;
488
+ /** OAuth access token. */
489
+ access_token?: string;
490
+ /** Data format for response. */
491
+ alt?: string;
492
+ /** JSONP */
493
+ callback?: string;
494
+ /** Selector specifying which fields to include in a partial response. */
495
+ fields?: string;
496
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
497
+ key?: string;
498
+ /** Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */
499
+ name: string;
500
+ /** OAuth 2.0 token for the current user. */
501
+ oauth_token?: string;
502
+ /** Returns response with indentations and line breaks. */
503
+ prettyPrint?: boolean;
504
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
505
+ quotaUser?: string;
506
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
507
+ upload_protocol?: string;
508
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
509
+ uploadType?: string;
510
+ },
511
+ body: StopScanRunRequest
512
+ ): Request<ScanRun>;
513
+ crawledUrls: CrawledUrlsResource;
514
+ findings: FindingsResource;
515
+ findingTypeStats: FindingTypeStatsResource;
516
+ }
517
+ interface ScanConfigsResource {
518
+ /** Creates a new ScanConfig. */
519
+ create(request: {
520
+ /** V1 error format. */
521
+ '$.xgafv'?: string;
522
+ /** OAuth access token. */
523
+ access_token?: string;
524
+ /** Data format for response. */
525
+ alt?: string;
526
+ /** JSONP */
527
+ callback?: string;
528
+ /** Selector specifying which fields to include in a partial response. */
529
+ fields?: string;
530
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
531
+ key?: string;
532
+ /** OAuth 2.0 token for the current user. */
533
+ oauth_token?: string;
534
+ /** Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. */
535
+ parent: string;
536
+ /** Returns response with indentations and line breaks. */
537
+ prettyPrint?: boolean;
538
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
539
+ quotaUser?: string;
540
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
541
+ upload_protocol?: string;
542
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
543
+ uploadType?: string;
544
+ /** Request body */
545
+ resource: ScanConfig;
546
+ }): Request<ScanConfig>;
547
+ create(
548
+ request: {
549
+ /** V1 error format. */
550
+ '$.xgafv'?: string;
551
+ /** OAuth access token. */
552
+ access_token?: string;
553
+ /** Data format for response. */
554
+ alt?: string;
555
+ /** JSONP */
556
+ callback?: string;
557
+ /** Selector specifying which fields to include in a partial response. */
558
+ fields?: string;
559
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
560
+ key?: string;
561
+ /** OAuth 2.0 token for the current user. */
562
+ oauth_token?: string;
563
+ /** Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. */
564
+ parent: string;
565
+ /** Returns response with indentations and line breaks. */
566
+ prettyPrint?: boolean;
567
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
568
+ quotaUser?: string;
569
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
570
+ upload_protocol?: string;
571
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
572
+ uploadType?: string;
573
+ },
574
+ body: ScanConfig
575
+ ): Request<ScanConfig>;
576
+ /** Deletes an existing ScanConfig and its child resources. */
577
+ delete(request?: {
578
+ /** V1 error format. */
579
+ '$.xgafv'?: string;
580
+ /** OAuth access token. */
581
+ access_token?: string;
582
+ /** Data format for response. */
583
+ alt?: string;
584
+ /** JSONP */
585
+ callback?: string;
586
+ /** Selector specifying which fields to include in a partial response. */
587
+ fields?: string;
588
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
589
+ key?: string;
590
+ /** Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
591
+ name: string;
592
+ /** OAuth 2.0 token for the current user. */
593
+ oauth_token?: string;
594
+ /** Returns response with indentations and line breaks. */
595
+ prettyPrint?: boolean;
596
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
597
+ quotaUser?: string;
598
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
599
+ upload_protocol?: string;
600
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
601
+ uploadType?: string;
602
+ }): Request<{}>;
603
+ /** Gets a ScanConfig. */
604
+ get(request?: {
605
+ /** V1 error format. */
606
+ '$.xgafv'?: string;
607
+ /** OAuth access token. */
608
+ access_token?: string;
609
+ /** Data format for response. */
610
+ alt?: string;
611
+ /** JSONP */
612
+ callback?: string;
613
+ /** Selector specifying which fields to include in a partial response. */
614
+ fields?: string;
615
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
616
+ key?: string;
617
+ /** Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
618
+ name: string;
619
+ /** OAuth 2.0 token for the current user. */
620
+ oauth_token?: string;
621
+ /** Returns response with indentations and line breaks. */
622
+ prettyPrint?: boolean;
623
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
624
+ quotaUser?: string;
625
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
626
+ upload_protocol?: string;
627
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
628
+ uploadType?: string;
629
+ }): Request<ScanConfig>;
630
+ /** Lists ScanConfigs under a given project. */
631
+ list(request?: {
632
+ /** V1 error format. */
633
+ '$.xgafv'?: string;
634
+ /** OAuth access token. */
635
+ access_token?: string;
636
+ /** Data format for response. */
637
+ alt?: string;
638
+ /** JSONP */
639
+ callback?: string;
640
+ /** Selector specifying which fields to include in a partial response. */
641
+ fields?: string;
642
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
643
+ key?: string;
644
+ /** OAuth 2.0 token for the current user. */
645
+ oauth_token?: string;
646
+ /** The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */
647
+ pageSize?: number;
648
+ /** A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */
649
+ pageToken?: string;
650
+ /** Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. */
651
+ parent: string;
652
+ /** Returns response with indentations and line breaks. */
653
+ prettyPrint?: boolean;
654
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
655
+ quotaUser?: string;
656
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
657
+ upload_protocol?: string;
658
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
659
+ uploadType?: string;
660
+ }): Request<ListScanConfigsResponse>;
661
+ /** Updates a ScanConfig. This method support partial update of a ScanConfig. */
662
+ patch(request: {
663
+ /** V1 error format. */
664
+ '$.xgafv'?: string;
665
+ /** OAuth access token. */
666
+ access_token?: string;
667
+ /** Data format for response. */
668
+ alt?: string;
669
+ /** JSONP */
670
+ callback?: string;
671
+ /** Selector specifying which fields to include in a partial response. */
672
+ fields?: string;
673
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
674
+ key?: string;
675
+ /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
676
+ name: string;
677
+ /** OAuth 2.0 token for the current user. */
678
+ oauth_token?: string;
679
+ /** Returns response with indentations and line breaks. */
680
+ prettyPrint?: boolean;
681
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
682
+ quotaUser?: string;
683
+ /** Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */
684
+ updateMask?: string;
685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
686
+ upload_protocol?: string;
687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
688
+ uploadType?: string;
689
+ /** Request body */
690
+ resource: ScanConfig;
691
+ }): Request<ScanConfig>;
692
+ patch(
693
+ request: {
694
+ /** V1 error format. */
695
+ '$.xgafv'?: string;
696
+ /** OAuth access token. */
697
+ access_token?: string;
698
+ /** Data format for response. */
699
+ alt?: string;
700
+ /** JSONP */
701
+ callback?: string;
702
+ /** Selector specifying which fields to include in a partial response. */
703
+ fields?: string;
704
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
705
+ key?: string;
706
+ /** The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */
707
+ name: string;
708
+ /** OAuth 2.0 token for the current user. */
709
+ oauth_token?: string;
710
+ /** Returns response with indentations and line breaks. */
711
+ prettyPrint?: boolean;
712
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
713
+ quotaUser?: string;
714
+ /** Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */
715
+ updateMask?: string;
716
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
717
+ upload_protocol?: string;
718
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
719
+ uploadType?: string;
720
+ },
721
+ body: ScanConfig
722
+ ): Request<ScanConfig>;
723
+ /** Start a ScanRun according to the given ScanConfig. */
724
+ start(request: {
725
+ /** V1 error format. */
726
+ '$.xgafv'?: string;
727
+ /** OAuth access token. */
728
+ access_token?: string;
729
+ /** Data format for response. */
730
+ alt?: string;
731
+ /** JSONP */
732
+ callback?: string;
733
+ /** Selector specifying which fields to include in a partial response. */
734
+ fields?: string;
735
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
736
+ key?: string;
737
+ /** Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
738
+ name: string;
739
+ /** OAuth 2.0 token for the current user. */
740
+ oauth_token?: string;
741
+ /** Returns response with indentations and line breaks. */
742
+ prettyPrint?: boolean;
743
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
744
+ quotaUser?: string;
745
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
746
+ upload_protocol?: string;
747
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
748
+ uploadType?: string;
749
+ /** Request body */
750
+ resource: StartScanRunRequest;
751
+ }): Request<ScanRun>;
752
+ start(
753
+ request: {
754
+ /** V1 error format. */
755
+ '$.xgafv'?: string;
756
+ /** OAuth access token. */
757
+ access_token?: string;
758
+ /** Data format for response. */
759
+ alt?: string;
760
+ /** JSONP */
761
+ callback?: string;
762
+ /** Selector specifying which fields to include in a partial response. */
763
+ fields?: string;
764
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
765
+ key?: string;
766
+ /** Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */
767
+ name: string;
768
+ /** OAuth 2.0 token for the current user. */
769
+ oauth_token?: string;
770
+ /** Returns response with indentations and line breaks. */
771
+ prettyPrint?: boolean;
772
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
773
+ quotaUser?: string;
774
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
775
+ upload_protocol?: string;
776
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
777
+ uploadType?: string;
778
+ },
779
+ body: StartScanRunRequest
780
+ ): Request<ScanRun>;
781
+ scanRuns: ScanRunsResource;
782
+ }
783
+ interface ProjectsResource {
784
+ scanConfigs: ScanConfigsResource;
785
+ }
786
+
787
+ const projects: ProjectsResource;
788
+ }
1136
789
  }