forked from SchemaStore/schemastore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
airlock-microgateway-3.2.json
1956 lines (1956 loc) · 88.5 KB
/
airlock-microgateway-3.2.json
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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/airlock-microgateway-3.2.json",
"additionalProperties": false,
"definitions": {
"DefaultActionDto": {
"title": "dto action",
"type": "object",
"properties": {
"enabled": {
"type": ["boolean", "null"],
"description": "Enable this default header action"
},
"name": {
"type": ["string", "null"],
"description": "Name of the default header action"
}
},
"additionalProperties": false
},
"ExpertSettingsDto-nullable": {
"type": ["object", "null"],
"properties": {
"apache": {
"type": ["string", "null"],
"description": "Expert settings for the Apache httpd."
},
"security_gate": {
"type": ["string", "null"],
"description": "Expert settings for the Security Gate."
}
},
"additionalProperties": false
},
"PatternDto-nullable": {
"type": ["object", "null"],
"properties": {
"ignore_case": {
"type": "boolean",
"description": "Whether to ignore case.",
"default": "true"
},
"inverted": {
"type": "boolean",
"description": "Whether to invert the match.",
"default": "false"
},
"pattern": {
"type": "string",
"description": "A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \".*\""
}
},
"required": ["pattern"],
"additionalProperties": false
},
"PatternWithRewriteDto-nullable": {
"type": ["object", "null"],
"properties": {
"regex": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "The regular expression, which matches the parts which should be rewritten."
}
]
},
"substitution": {
"type": ["string", "null"],
"description": "The rewrite expression."
}
},
"additionalProperties": false
},
"PatternWithoutInvertDto": {
"title": "pattern",
"type": "object",
"properties": {
"ignore_case": {
"type": "boolean",
"description": "Whether to ignore case.",
"default": "true"
},
"pattern": {
"type": "string",
"description": "A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \".*\""
}
},
"required": ["pattern"],
"additionalProperties": false
},
"PatternWithoutInvertDto-nullable": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PatternWithoutInvertDto"
}
]
},
"RemoveHeaderActionDto-nullable": {
"type": ["object", "null"],
"properties": {
"name": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern for the header name."
}
]
},
"value": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern for the header value."
}
]
}
},
"additionalProperties": false
},
"RewriteHeaderValueDto-nullable": {
"type": ["object", "null"],
"properties": {
"name": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern for the header name."
}
]
},
"replace": {
"type": ["string", "null"],
"description": "A string to rewrite the header value with. Can make back-references to the header value pattern."
},
"value": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern for the header value."
}
]
}
},
"additionalProperties": false
},
"SimpleHeaderActionDto-nullable": {
"type": ["object", "null"],
"properties": {
"name": {
"type": ["string", "null"],
"description": "The name of the header to add."
},
"value": {
"type": ["string", "null"],
"description": "The value of the header to add."
}
},
"additionalProperties": false
},
"SimplePatternDto-nullable": {
"type": ["object", "null"],
"properties": {
"pattern": {
"type": ["string", "null"],
"description": "The actual pattern."
}
},
"additionalProperties": false
}
},
"properties": {
"apps": {
"type": "array",
"items": {
"title": "application",
"type": "object",
"properties": {
"mappings": {
"type": "array",
"items": {
"title": "mapping",
"type": "object",
"properties": {
"access_token": {
"type": ["object", "null"],
"properties": {
"audittoken": {
"type": ["boolean", "null"],
"description": "If the 'sub' claim should be extracted from the JWT and be used as audit token of the current session",
"default": "false"
},
"claims": {
"description": "All specified claims are checked and must match the claim's value of the decoded token. If a claim is an array, at least one entry must match the specified regex.",
"type": "array",
"items": {
"title": "claim",
"type": "object",
"properties": {
"claim": {
"type": ["string", "null"],
"description": "The name of the claim you want to restrict."
},
"regex": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "The regular expression that must match the value of the specified claim name."
}
]
}
},
"additionalProperties": false
}
},
"expiry_checked": {
"type": ["boolean", "null"],
"description": "If the JWT standard claims expiry (exp) and not before (nbf) will be checked and must be valid.",
"default": "false"
},
"extraction": {
"type": ["object", "null"],
"properties": {
"cookie": {
"type": ["string", "null"],
"description": "From which cookie the token should be extracted."
},
"header": {
"allOf": [
{
"$ref": "#/definitions/PatternWithRewriteDto-nullable"
},
{
"description": "How the token should be extracted from the request headers."
}
]
},
"mode": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["header", "parameter", "cookie"]
}
],
"description": "From which part of the request the token should be extracted. Possible values are 'header', 'parameter', 'cookie'.",
"default": "header"
},
"parameter": {
"type": ["string", "null"],
"description": "From which query parameter the token should be extracted."
}
},
"additionalProperties": false,
"description": "How the token should be extracted."
},
"jwks_providers": {
"description": "List of JWKS service providers referenced by their name. Can be local or remote providers.",
"type": "array",
"items": {
"type": "string"
}
},
"mandatory": {
"type": ["boolean", "null"],
"description": "If disabled, requests without a token are accepted. However, if a token is present,it is extracted and validated and the configured restrictions and role extractions are applied. ",
"default": "false"
},
"roles": {
"description": "Specifies which roles should be extracted from the claims.",
"type": "array",
"items": {
"title": "role",
"type": "object",
"properties": {
"claim": {
"type": ["string", "null"],
"description": "Name of the claim you want to extract a role from."
},
"extraction": {
"allOf": [
{
"$ref": "#/definitions/PatternWithRewriteDto-nullable"
},
{
"description": "The regular expression to match the role extraction and the rewrite expression of the role."
}
]
},
"token_lifetime": {
"type": ["boolean", "null"],
"description": "If enabled, the expiry claim (exp) of the JWT will be used as the role lifetime.",
"default": "false"
}
},
"additionalProperties": false
}
},
"signature_mandatory": {
"type": ["boolean", "null"],
"description": "Enforce a signed JWT",
"default": "true"
},
"skew": {
"type": ["integer", "null"],
"description": "The allowed skew when checking expiry / not before in seconds.",
"default": "10"
},
"tech_client_id_claim": {
"type": ["string", "null"],
"description": "The claim to extract the technical client id from."
}
},
"additionalProperties": false
},
"allow_rules": {
"type": "array",
"items": {
"title": "allowed roles",
"type": "object",
"properties": {
"content_type": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern to match the content type for this allow rule."
}
]
},
"enabled": {
"type": "boolean",
"description": "Enable the allow rule.",
"default": "true"
},
"log_only": {
"type": "boolean",
"description": "Whether to log requests not matching this allow rule instead of blocking them.",
"default": "false"
},
"method": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern to match the http method for this allow rule."
}
]
},
"name": {
"type": "string",
"description": "Unique name for the allow rule. If omitted, a unique name will be generated. To enable/disable the default allow rule or one from a mapping_template_file, use the same name.",
"default": "Allow all"
},
"path": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A pattern to match the path."
}
]
}
},
"additionalProperties": false
}
},
"api_security": {
"type": ["object", "null"],
"properties": {
"json_content_type": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "JSON objects are parsed only if their content-type matches the specified pattern.",
"default": "json"
}
]
},
"openapi": {
"type": ["object", "null"],
"properties": {
"log_only": {
"type": ["boolean", "null"],
"description": "If enabled, potential attack requests are only logged but not blocked.",
"default": "false"
},
"path_matching": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["client_view", "backend_view"]
}
],
"description": "The Microgateway mapping can be configured to rewrite the incoming URL to a different back-end URL (asymmetric mappings). Due to this rewriting, the incoming URL path (client_view) will be different from the back-end URL path (backend_view).",
"default": "client_view"
},
"response_validation": {
"type": ["boolean", "null"],
"description": "Check responses against API specification.",
"default": "false"
},
"spec": {
"type": ["string", "null"],
"description": "The OpenAPI specification."
},
"spec_file": {
"type": ["string", "null"],
"description": "The OpenAPI file path.",
"default": "/config/openapi.json"
}
},
"additionalProperties": false,
"description": "The specification to validate against."
},
"treat_json_objects_as_parameters": {
"type": ["boolean", "null"],
"description": "If enabled, Microgateway parses JSON objects in requests and filters JSON attributes with allow rules and deny rules.",
"default": "true"
},
"treat_path_segments_as_parameters": {
"type": ["boolean", "null"],
"description": "If enabled, each path segment is interpreted as a separate parameter value and the deny rules for parameter values are applied to it.",
"default": "true"
}
},
"additionalProperties": false
},
"auth": {
"type": ["object", "null"],
"properties": {
"access": {
"description": "A list of access restrictions can be created. Each request matching the combination of HTTP method and path of a access restriction must have at least one of the specified roles to access the service. All matching restrictions must be satisfied to gain access.",
"type": "array",
"items": {
"title": "access restriction",
"type": "object",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "Can contain regular expressions that are applied when the HTTP method of a request matches one of the expressions. Use an empty pattern if all HTTP methods should match."
}
]
},
"path": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "Can contain regular expressions that are applied when the requested path of the query matches the expressions. Use an empty pattern if all paths should match."
}
]
},
"roles": {
"description": "Can contain a list of roles for this service. Only sessions that have at least one of these roles will be able to access the service.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"client_certificate": {
"type": ["object", "null"],
"properties": {
"verification": {
"type": "string",
"enum": ["inherit", "optional", "required"],
"description": "The client certificate verification mode to use on this mapping. This can be used to override the setting from the virtual host with a stronger verification level (e.g. off -> optional or optional -> required). Possible values are 'inherit', 'optional' or 'required'.",
"default": "inherit"
}
},
"additionalProperties": false
},
"denied_access_url": {
"type": ["string", "null"],
"description": "Defines the location of the authentication service. In case the required role for the mapping is missing on the current session, Airlock Gateway will redirect the client to this location. If this value is missing (default), the Global Denied Access URL will be used.",
"default": "/auth/check-login"
},
"flow": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"redirect",
"deny_access",
"one_shot",
"one_shot_with_body",
"ntlm"
]
}
],
"description": "The authentication flow, allowed values are: redirect, deny_access, one_shot, one_shot_with_body, ntlm",
"default": "redirect"
},
"logout_propagation_path": {
"type": ["string", "null"],
"description": "In order to allow clean session termination on back-end systems when an Airlock Gateway session terminates, the administrator can configure one logout path per mapping."
}
},
"additionalProperties": false
},
"backend": {
"type": ["object", "null"],
"properties": {
"expert_settings": {
"type": ["object", "null"],
"properties": {
"security_gate": {
"type": ["string", "null"],
"description": "Expert settings for the Security Gate."
}
},
"additionalProperties": false
},
"hosts": {
"type": "array",
"items": {
"title": "host",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The hostname of the back-end host. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.",
"default": "backend",
"pattern": "^[A-Za-z0-9.\\-_:]+$"
},
"port": {
"type": "integer",
"description": "Configuring a back-end port.",
"default": "8080",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"type": "string",
"enum": ["https", "http"],
"description": "Allowed values are: http, https",
"default": "http"
}
},
"additionalProperties": false
}
},
"name": {
"type": "string",
"description": "The unique name of the back-end. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.",
"default": "backendGroup",
"pattern": "^[A-Za-z0-9.\\-_:]+$"
}
},
"additionalProperties": false
},
"backend_path": {
"type": ["string", "null"],
"description": "The back-end path specifies the internal back-end path, i.e. the path of the request sent to the application server.",
"default": "/"
},
"compress_response_traffic": {
"type": ["boolean", "null"],
"description": "Specifies whether Airlock Microgateway should compress the output on-the-fly for the client browser if supported and requested by the browser.",
"default": "false"
},
"control_api": {
"type": ["boolean", "null"],
"description": "Specifies whether the connected back-end service is allowed to use the Airlock Microgateway Control API via the control cookie mechanism. The Control API is normally used by authentication applications to communicate with the Microgateway.",
"default": "false"
},
"cookies": {
"type": ["object", "null"],
"properties": {
"encrypted": {
"allOf": [
{
"$ref": "#/definitions/SimplePatternDto-nullable"
},
{
"description": "Cookies that should be cryptographically encrypted before being sent to the client."
}
]
},
"passthrough": {
"allOf": [
{
"$ref": "#/definitions/SimplePatternDto-nullable"
},
{
"description": "Cookies that should be passed in plain format to the client."
}
]
}
},
"additionalProperties": false
},
"csrf_token": {
"type": ["object", "null"],
"properties": {
"enabled": {
"type": ["boolean", "null"],
"description": "Whether to enable automatic CSRF token injection and validation on this mapping.",
"default": "false"
},
"exceptions": {
"description": "All incoming URLs that match one of these patterns are accepted by Airlock Microgateway without a valid CSRF token.",
"type": ["array", "null"],
"items": {
"title": "exception",
"type": "object",
"properties": {
"path": {
"$ref": "#/definitions/PatternWithoutInvertDto-nullable"
}
},
"additionalProperties": false
}
},
"invalid_token_redirect_location": {
"type": ["string", "null"],
"description": "Specifies the location (e.g. /index.html) to which the client is redirected if a missing or invalid CSRF token is detected.",
"default": "/%ENTRYPATH%"
}
},
"additionalProperties": false
},
"deny_rule_groups": {
"type": "array",
"items": {
"title": "denied rule groups",
"type": "object",
"properties": {
"enabled": {
"type": ["boolean", "null"],
"description": "Enable deny rule group",
"default": "true"
},
"exceptions": {
"type": "array",
"items": {
"title": "exception",
"type": "object",
"properties": {
"content_type": {
"$ref": "#/definitions/PatternDto-nullable"
},
"header_name": {
"$ref": "#/definitions/PatternDto-nullable"
},
"header_value": {
"$ref": "#/definitions/PatternDto-nullable"
},
"method": {
"$ref": "#/definitions/PatternDto-nullable"
},
"parameter_name": {
"$ref": "#/definitions/PatternDto-nullable"
},
"parameter_value": {
"$ref": "#/definitions/PatternDto-nullable"
},
"path": {
"$ref": "#/definitions/PatternDto-nullable"
}
},
"additionalProperties": false
}
},
"level": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["basic", "standard", "strict"]
}
],
"description": "Allowed values are: basic, standard, strict.",
"default": "standard"
},
"log_only": {
"type": ["boolean", "null"],
"description": "If enabled, offending requests are not blocked but only logged",
"default": "false"
},
"rule_group_keys": {
"description": "If deny rule group key is defined, the settings will only affect the specific deny rule group.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"entry_path": {
"type": ["object", "null"],
"properties": {
"enforce_trailing_slashes": {
"type": ["boolean", "null"],
"description": "Whether a trailing slash is mandatory at the end of the entry path or not.",
"default": "false"
},
"ignore_case": {
"type": ["boolean", "null"],
"description": "Whether to ignore case.",
"default": "false"
},
"type": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["directory", "regex"]
}
],
"description": "Allowed values are: directory, regex.",
"default": "directory"
},
"value": {
"type": ["string", "null"],
"description": "This specifies the external URL path.",
"default": "/"
}
},
"additionalProperties": false,
"description": "The entry path specifies the external URL path the mapping should be available under."
},
"env_cookies": {
"type": ["boolean", "null"],
"description": "Specifies whether Airlock environment cookies containing useful request information are sent to the connected back-end.",
"default": "false"
},
"expert_settings": {
"$ref": "#/definitions/ExpertSettingsDto-nullable"
},
"limits": {
"type": ["object", "null"],
"properties": {
"http_limits": {
"type": ["object", "null"],
"properties": {
"max_parameter_name_length": {
"type": ["integer", "null"],
"description": "Defines the maximum length of a parameter name in bytes.",
"default": "128"
},
"max_parameter_value_length": {
"type": ["integer", "null"],
"description": "Defines the maximum length for a parameter value in bytes.",
"default": "1024"
},
"max_parameters": {
"type": ["integer", "null"],
"description": "Defines the maximum number of parameters inside the request.",
"default": "128"
},
"parameter_length_exception": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "A regular expression which specifies any parameters which should not be checked against these length checks."
}
]
}
},
"additionalProperties": false,
"description": "The limits for HTTP parameters."
},
"json_limits": {
"type": ["object", "null"],
"properties": {
"max_array_items": {
"type": ["integer", "null"],
"description": "Defines the maximum number of items in a single JSON array (non-recursive).",
"default": "500"
},
"max_key_length": {
"type": ["integer", "null"],
"description": "Defines the maximum length for a JSON key, also known as 'JSON property' or 'JSON object member' in bytes.",
"default": "256"
},
"max_keys": {
"type": ["integer", "null"],
"description": "Defines the maximum number of keys of a single JSON object (non-recursive).",
"default": "250"
},
"max_length_exception": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "Defines a regular expression to exclude JSON keys and the corresponding values from the length checks. The exceptions must be specified in the '#json' format for a JSON key."
}
]
},
"max_nesting_depth": {
"type": ["integer", "null"],
"description": "Defines the maximum depth of nesting for JSON objects and JSON arrays.",
"default": "100"
},
"max_total_entries": {
"type": ["integer", "null"],
"description": "Defines the maximum number of keys and array items in the whole JSON document (recursive).",
"default": "150000"
},
"max_value_length": {
"type": ["integer", "null"],
"description": "Defines the maximum length for a JSON value (string or numbers) in bytes.",
"default": "8192"
}
},
"additionalProperties": false,
"description": "The limits for JSON structures."
},
"max_path_length": {
"type": ["integer", "null"],
"description": "Defines the maximum path length for requests to the current mapping in bytes.",
"default": "1024"
},
"max_request_body_size": {
"type": ["integer", "null"],
"description": "The maximum allowed total size of the request body in bytes. It specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in the request body. To restrict the size of file uploads, set this limit to the maximum combined size of all files uploaded at once.",
"default": "104857600"
}
},
"additionalProperties": false
},
"mapping_template_file": {
"type": ["string", "null"],
"description": "The Airlock Gateway mapping template file path.",
"default": "/config/mapping.xml"
},
"name": {
"type": ["string", "null"],
"description": "The unique name of the mapping.",
"default": "root"
},
"operational_mode": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["production", "integration"]
}
],
"description": "Allowed values are: production, integration.",
"default": "production"
},
"parameter_pollution": {
"type": ["object", "null"],
"properties": {
"mixed_type": {
"type": ["object", "null"],
"properties": {
"block_duplicates": {
"type": ["boolean", "null"],
"description": "If enabled, requests are blocked if they contain the same parameter names with different parameter types (e.g. \"id\" is present as a POST parameter and as a query parameter simultaneously).",
"default": "true"
},
"log_only": {
"type": ["boolean", "null"],
"description": "If enabled, offending requests are not blocked but only logged.",
"default": "false"
},
"parameter_name_exception": {
"allOf": [
{
"$ref": "#/definitions/PatternDto-nullable"
},
{
"description": "Exception pattern to exclude parameters from the parameter pollution detection."
}
]
}
},
"additionalProperties": false
},
"same_type": {
"type": ["object", "null"],
"properties": {
"join_duplicates": {
"type": ["boolean", "null"],
"description": "If enabled, all the different values of a repeated parameter are joined by comma (in order of appearance). The aggregate value is then checked against deny rules (instead of the individual values).",
"default": "true"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"priority": {
"type": ["integer", "null"],
"description": "Specifies the priority of this mapping (highest: -999, lowest: 999) when a request matches the entry path of multiple mappings.\nAll mappings with entry_path.type regex must have a unique priority.",
"default": "0",
"minimum": -999,
"maximum": 999
},
"request": {
"type": ["object", "null"],
"properties": {
"custom_actions": {
"description": "A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.",
"type": ["array", "null"],
"items": {
"title": "custom action",
"type": "object",
"properties": {
"add_header": {
"allOf": [
{
"$ref": "#/definitions/SimpleHeaderActionDto-nullable"
},
{
"description": "An action to add a header to all requests."
}
]
},
"add_missing_header": {
"allOf": [
{
"$ref": "#/definitions/SimpleHeaderActionDto-nullable"
},
{
"description": "An action to add a header to all requests if it is not already present."
}
]
},
"add_or_replace_header": {
"allOf": [
{
"$ref": "#/definitions/SimpleHeaderActionDto-nullable"
},
{
"description": "An action to add or replace an existing header to all requests."
}
]
},
"geolocation_redirect": {
"type": ["object", "null"],
"properties": {
"continent_codes": {
"description": "A list of alpha-2 continent codes to redirect clients from. See here: https://en.wikipedia.org/wiki/List_of_sovereign_states_and_dependent_territories_by_continent_(data_file)",
"default": "[]",
"type": ["array", "null"],
"items": {
"type": "string",
"default": "[]"
}
},
"country_codes": {
"description": "A list of country codes to redirect clients from. See here for alpha-2 codes to use: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2",
"default": "[]",
"type": ["array", "null"],
"items": {
"type": "string",
"default": "[]"
}