/
APIGatewayApplication.json
1735 lines (1735 loc) · 103 KB
/
APIGatewayApplication.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
{
"swagger" : "2.0",
"info" : {
"description" : "API Gateway Application Management Service allows you to manage the Applications in API Gateway. Any user with the 'Manage applications' functional privilege can manage the APIs in the API Gateway. By default, the users who are part of either API-Gateway-Providers or API-Gateway-Administrators groups will have this privilege.\n\n An application defines the precise identifiers by which messages from a particular consumer application is recognized at run time. The identifiers can be, for example, user name in HTTP headers, a range of IP addresses, etc., such that API Gateway can identify or authenticate the consumers that are requesting an API. To view the list of all possible identifiers, refer the sample payload for /applications POST request.\n\n. The ability of API Gateway to relate a request to a specific consumer application enables it to:\n\n 1. Control access to an API at run time (that is, allow only authorized consumer applications to invoke an API).\n\n 2. Monitor an API for violations of a Service-Level Agreement (SLA) for a specified application.\n\n 3. Indicate the consumer application to which a logged transaction event belongs.\n\n\n\n An application has the following attributes for specifying the identifiers:\n\n 1. IP address, which specifies one or more IP addresses that identify requests from a particular consumer application. Example: 192.168.0.10\n\n This attribute is queried when the Identify and Authorize Application policy is configured to identify consumer applications by IP address.\n\n 2. JWT claims set, which specifies one or more claims that identify requests from a particular consumer application. The claims are a set of name-value pairs that provide sufficient information about the application. Example: sub = Administrator.\n\n This attribute is queried when the Identify and Authorize Application policy is configured to identify consumer applications by JSON Web Token (JWT).\n\n 3. Consumer certificate, which specifies the X.509 certificates that identify requests from a particular consumer.\n\n This attribute is queried when the Identify and authenticate consumer policy is configured to identify the consumer applications by a consumer certificate.\n\n 4. Identification token, which specifies the host names, user names or other distinguishing strings that identify requests from a particular consumer application.\n\n This attribute is queried when the Identify and authenticate consumer policy action is configured to identify consumer applications by host name, HTTP user name, and WSS user name.\n\n \n\n As an API provider or an API Gateway Administrator you can create and manage applications, and register applications with the APIs.\n\n These are the high level stages of managing and using an application:\n\n 1. API developers request the API Gateway administrators to create an application for access as per the required identification criteria.\n\n 2. API Gateway provider or administrator validates the request and creates a new application, there by provisioning the application specific access tokens (API access key and OAuth credentials).\n\n 3. API Developer, upon finding a suitable API, sends a request to API Gateway for consumption by providing the application details.\n\n 4. After validating the request, API Gateway provider or administrator associates the application with the API. Keys are generated for applications and not for every API that the application consumes. \n\n Note: The approval process, if any, is handled by the requesting application and not handled by API Gateway.\n\n 5. The API developer can then use the application with the proper identifier (such as the access key or identifier) to access the API. \n\n Strategies: \n\n A strategy is a way to authenticate the incoming request and provides multiple authentication mechanisms or multiple authorization servers for a single authentication scheme. API Gateway identifies the application and validates the token submitted through the strategy configured in the application. You can create multiple strategies authorized by an API for an application. For example, in case of OAuth authentication scheme, you want the application to support both OKTA and PINGFederate or OKTA with multiple tenants. This can be configured as OAuth strategy for the application.",
"version" : "10.11",
"title" : "API Gateway Application Management Service"
},
"host" : "localhost:5555",
"basePath" : "/rest/apigateway",
"schemes" : [ "http" ],
"consumes" : [ "plain/text" ],
"produces" : [ "application/json" ],
"paths" : {
"/applications" : {
"get" : {
"description" : "The method retrieves a list of available applications in API Gateway.",
"operationId" : "getApplications",
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "This status code indicates that a list of the available applications is retrieved successfully.",
"examples" : {
"application/json" : "{\n \"applications\": [\n {\n \"name\": \"TestSampleApp\",\n \"description\": null,\n \"contactEmails\": [],\n \"identifiers\": [\n {\n \"id\": \"3ce6f4df-e773-4fdb-bed3-3d63b5cb520c\",\n \"name\": \"Username\",\n \"key\": \"httpBasicAuth\",\n \"value\": [\n \"Administrator\"\n ]\n }\n ],\n \"siteURLs\": [],\n \"jsOrigins\": [],\n \"authStrategyIds\": [\n \"81df9682-6a28-4ebc-92fd-2c486d3f75c2\"\n ],\n \"version\": \"1.0\",\n \"id\": \"803b7f16-45c6-4b1c-be26-4da053d40640\",\n \"created\": \"2018-12-04 05:27:56 GMT\",\n \"lastupdated\": null,\n \"owner\": \"Administrator\",\n \"consumingAPIs\": [],\n \"accessTokens\": {\n \"apiAccessKey_credentials\": {\n \"apiAccessKey\": \"f293cbb5cb0f1367ecc55b4c5b1717dad4073f77d2bde869cf8ee0162cc08f38\",\n \"expirationInterval\": null,\n \"expirationDate\": null,\n \"expired\": false\n },\n \"oauth_credentials\": {\n \"clientID\": null,\n \"clientSecret\": null,\n \"clientName\": null,\n \"scopes\": null,\n \"token_lifetime\": null,\n \"token_refresh_limit\": null,\n \"redirect_uris\": [],\n \"Type\": \"confidential\"\n }\n }\n ,\r\n\t\t\t\"teams\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"id\": \"Administrators\",\r\n\t\t\t\t\t\"name\": \"Administrators\",\r\n\t\t\t\t\t\"canDelete\": \"false\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"id\": \"Default\",\r\n\t\t\t\t\t\"name\": \"Default\",\r\n\t\t\t\t\t\"canDelete\": \"true\"\r\n\t\t\t\t}\r\n\t\t\t] }\n ]\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that a list of the available applications is retrieved successfully.",
"examples" : {
"application/json" : "{\n \"applications\": [\n {\n \"name\": \"TestSampleApp\",\n \"description\": null,\n \"contactEmails\": [],\n \"identifiers\": [\n {\n \"id\": \"3ce6f4df-e773-4fdb-bed3-3d63b5cb520c\",\n \"name\": \"Username\",\n \"key\": \"httpBasicAuth\",\n \"value\": [\n \"Administrator\"\n ]\n }\n ],\n \"siteURLs\": [],\n \"jsOrigins\": [],\n \"authStrategyIds\": [\n \"81df9682-6a28-4ebc-92fd-2c486d3f75c2\"\n ],\n \"version\": \"1.0\",\n \"id\": \"803b7f16-45c6-4b1c-be26-4da053d40640\",\n \"created\": \"2018-12-04 05:27:56 GMT\",\n \"lastupdated\": null,\n \"owner\": \"Administrator\",\n \"consumingAPIs\": [],\n \"accessTokens\": {\n \"apiAccessKey_credentials\": {\n \"apiAccessKey\": \"f293cbb5cb0f1367ecc55b4c5b1717dad4073f77d2bde869cf8ee0162cc08f38\",\n \"expirationInterval\": null,\n \"expirationDate\": null,\n \"expired\": false\n },\n \"oauth_credentials\": {\n \"clientID\": null,\n \"clientSecret\": null,\n \"clientName\": null,\n \"scopes\": null,\n \"token_lifetime\": null,\n \"token_refresh_limit\": null,\n \"redirect_uris\": [],\n \"Type\": \"confidential\"\n }\n }\n ,\r\n\t\t\t\"teams\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"id\": \"Administrators\",\r\n\t\t\t\t\t\"name\": \"Administrators\",\r\n\t\t\t\t\t\"canDelete\": \"false\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"id\": \"Default\",\r\n\t\t\t\t\t\"name\": \"Default\",\r\n\t\t\t\t\t\"canDelete\": \"true\"\r\n\t\t\t\t}\r\n\t\t\t] }\n ]\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"post" : {
"description" : "The method creates an application in API Gateway. If you want to use JWT/Oauth/OpenID credentials in your application, you can create a JWT/Oauth/OpenID auth strategy using the resource /strategies POST. You can associate the created strategies to the application using /applications/{applicationId} PUT request using the property authStrategyIds in application. To associate the application to one or more APIs, refer the resource /applications/{applicationId}/apis PUT.",
"operationId" : "createApplication",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter describes the request payload of an application that is to be created in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Application"
},
"x-examples" : {
"application/json" : "{\r\n\t\"name\": \"TestApp\",\r\n\t\"description\": \"My Test Application\",\r\n\t\"version\": \"1.0\",\r\n\t\"contactEmails\": [],\r\n\t\"siteURLs\": [],\r\n\t\"identifiers\": [\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"partner1\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"Partner ID\",\r\n\t\t\t\"key\": \"partnerId\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"10.60.37.12-10.60.37.15\",\r\n\t\t\t\t\"10.60.37.16-10.60.37.17\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"IP Addresses\",\r\n\t\t\t\"key\": \"ipAddressRange\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"LS0t...o=\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"localhostcert.der\",\r\n\t\t\t\"key\": \"httpsCertificate\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"{\\\"claim1\\\":\\\"val1\\\",\\\"claim2\\\":\\\"val2\\\"}\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"claimset1\",\r\n\t\t\t\"key\": \"jwtClaims\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"host1\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"Hostname\",\r\n\t\t\t\"key\": \"hostNameAddress\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"token1\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"Token\",\r\n\t\t\t\"key\": \"token\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"user1\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"Username\",\r\n\t\t\t\"key\": \"httpBasicAuth\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"wssuser1\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"WS-Security username\",\r\n\t\t\t\"key\": \"wssecUsernameToken\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"xpath1\"\r\n\t\t\t],\r\n\t\t\t\"name\": \"XPath\",\r\n\t\t\t\"key\": \"payloadElement\"\r\n\t\t}\r\n\t],\r\n\t\"consumingAPIs\": [],\r\n\t\"owner\": null\r\n}"
}
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the application has been successfully created in API Gateway.",
"examples" : {
"application/json" : "{\r\n\t\"name\": \"TestApp\",\r\n\t\"description\": \"My Test Application\",\r\n\t\"contactEmails\": [],\r\n\t\"identifiers\": [\r\n\t\t{\r\n\t\t\t\"id\": \"47252f48-b8ed-4759-8bfd-1a52ddc4e9cd\",\r\n\t\t\t\"name\": \"Hostname\",\r\n\t\t\t\"key\": \"hostNameAddress\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"host1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"ac3f2d03-f4dd-496e-bb0c-10b4e09958ab\",\r\n\t\t\t\"name\": \"localhostcert.der\",\r\n\t\t\t\"key\": \"httpsCertificate\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"LS0t...o=\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"3c1ba8c7-c3c7-4faf-bb4b-1ef5b8108175\",\r\n\t\t\t\"name\": \"Username\",\r\n\t\t\t\"key\": \"httpBasicAuth\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"user1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"89fc1704-092f-4b55-93d8-944260fe9e06\",\r\n\t\t\t\"name\": \"claimset1\",\r\n\t\t\t\"key\": \"jwtClaims\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"{\\\"claim1\\\":\\\"val1\\\",\\\"claim2\\\":\\\"val2\\\"}\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"7f9c9835-6727-4bc4-8ab1-e46147dfe42b\",\r\n\t\t\t\"name\": \"WS-Security username\",\r\n\t\t\t\"key\": \"wssecUsernameToken\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"wssuser1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"6b6c6006-8475-447f-89be-f6fee0d06e50\",\r\n\t\t\t\"name\": \"XPath\",\r\n\t\t\t\"key\": \"payloadElement\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"xpath1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"0f6ecdb8-f715-4828-b228-e8bc74d3e2f0\",\r\n\t\t\t\"name\": \"Token\",\r\n\t\t\t\"key\": \"token\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"token1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"732fb347-1e71-46e5-98ca-1b94e5d9cf94\",\r\n\t\t\t\"name\": \"IP Addresses\",\r\n\t\t\t\"key\": \"ipAddressRange\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"10.60.37.12-10.60.37.15\",\r\n\t\t\t\t\"10.60.37.16-10.60.37.17\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"d2042269-ffa2-459e-aa43-c2e9f9885c64\",\r\n\t\t\t\"name\": \"Partner ID\",\r\n\t\t\t\"key\": \"partnerId\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"partner1\"\r\n\t\t\t]\r\n\t\t}\r\n\t],\r\n\t\"siteURLs\": [],,\r\n\t\"jsOrigins\": [],\r\n \"authStrategyIds\": []\r\n\t\"version\": \"1.0\",\r\n\t\"id\": \"ea8700af-e7ce-4b57-8f60-1922f87e47a9\",\r\n\t\"created\": \"2019-11-01 09:47:53 GMT\",\r\n\t\"lastupdated\": null,\r\n\t\"owner\": \"Administrator\",\r\n\t\"consumingAPIs\": [],\r\n\t\"accessTokens\": {\r\n\t\t\"apiAccessKey_credentials\": {\r\n\t\t\t\"apiAccessKey\": \"2050c4b7-f51b-4a4d-9bb6-eca2bc590536\",\r\n\t\t\t\"expirationInterval\": null,\r\n\t\t\t\"expirationDate\": null,\r\n\t\t\t\"expired\": false\r\n\t\t}\r\n\t}\r\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the application has been successfully created in API Gateway.",
"examples" : {
"application/json" : "{\r\n\t\"name\": \"TestApp\",\r\n\t\"description\": \"My Test Application\",\r\n\t\"contactEmails\": [],\r\n\t\"identifiers\": [\r\n\t\t{\r\n\t\t\t\"id\": \"47252f48-b8ed-4759-8bfd-1a52ddc4e9cd\",\r\n\t\t\t\"name\": \"Hostname\",\r\n\t\t\t\"key\": \"hostNameAddress\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"host1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"ac3f2d03-f4dd-496e-bb0c-10b4e09958ab\",\r\n\t\t\t\"name\": \"localhostcert.der\",\r\n\t\t\t\"key\": \"httpsCertificate\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"LS0t...o=\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"3c1ba8c7-c3c7-4faf-bb4b-1ef5b8108175\",\r\n\t\t\t\"name\": \"Username\",\r\n\t\t\t\"key\": \"httpBasicAuth\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"user1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"89fc1704-092f-4b55-93d8-944260fe9e06\",\r\n\t\t\t\"name\": \"claimset1\",\r\n\t\t\t\"key\": \"jwtClaims\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"{\\\"claim1\\\":\\\"val1\\\",\\\"claim2\\\":\\\"val2\\\"}\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"7f9c9835-6727-4bc4-8ab1-e46147dfe42b\",\r\n\t\t\t\"name\": \"WS-Security username\",\r\n\t\t\t\"key\": \"wssecUsernameToken\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"wssuser1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"6b6c6006-8475-447f-89be-f6fee0d06e50\",\r\n\t\t\t\"name\": \"XPath\",\r\n\t\t\t\"key\": \"payloadElement\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"xpath1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"0f6ecdb8-f715-4828-b228-e8bc74d3e2f0\",\r\n\t\t\t\"name\": \"Token\",\r\n\t\t\t\"key\": \"token\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"token1\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"732fb347-1e71-46e5-98ca-1b94e5d9cf94\",\r\n\t\t\t\"name\": \"IP Addresses\",\r\n\t\t\t\"key\": \"ipAddressRange\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"10.60.37.12-10.60.37.15\",\r\n\t\t\t\t\"10.60.37.16-10.60.37.17\"\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"d2042269-ffa2-459e-aa43-c2e9f9885c64\",\r\n\t\t\t\"name\": \"Partner ID\",\r\n\t\t\t\"key\": \"partnerId\",\r\n\t\t\t\"value\": [\r\n\t\t\t\t\"partner1\"\r\n\t\t\t]\r\n\t\t}\r\n\t],\r\n\t\"siteURLs\": [],,\r\n\t\"jsOrigins\": [],\r\n \"authStrategyIds\": []\r\n\t\"version\": \"1.0\",\r\n\t\"id\": \"ea8700af-e7ce-4b57-8f60-1922f87e47a9\",\r\n\t\"created\": \"2019-11-01 09:47:53 GMT\",\r\n\t\"lastupdated\": null,\r\n\t\"owner\": \"Administrator\",\r\n\t\"consumingAPIs\": [],\r\n\t\"accessTokens\": {\r\n\t\t\"apiAccessKey_credentials\": {\r\n\t\t\t\"apiAccessKey\": \"2050c4b7-f51b-4a4d-9bb6-eca2bc590536\",\r\n\t\t\t\"expirationInterval\": null,\r\n\t\t\t\"expirationDate\": null,\r\n\t\t\t\"expired\": false\r\n\t\t}\r\n\t}\r\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"delete" : {
"description" : "The method deletes the specified applications in API Gateway.",
"operationId" : "deleteApplications",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ids",
"in" : "query",
"description" : "You can delete multiple applications using the query parameter 'ids' by providing the ids as comma-separated values. Example: /applications?ids=375db639-01f7-4488-b14f-09daae622e18,afb0b5c0-0b0e-4d44-b139-e64d0dbf028c",
"required" : false,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "This status code indicates that the specified application has been successfully deleted from API Gateway."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"204" : {
"description" : "This status code indicates that the specified application has been successfully deleted from API Gateway."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/applications/accessTokens" : {
"put" : {
"description" : "The method updates the expiry date of all the API Keys in the instance. The new expiry date is calculated based on the extended settings property 'apiKeyExpirationPeriod'. If 'apiKeyExpirationPeriod is empty, then the expiration date for all API Keys are set as unlimited.If 'apiKeyExpirationPeriod' is set to some accepted value (say 60min), then the expiry date is calculated as current time when this method is invoked + the expiration period (60min).Since this method updates expiry date for all API keys in the instance, take caution when you invoke this! Invoke this only if absolutely necessary and take necessary precautions!For example, your system might have applications to the scale of 1M or higher - make sure to configure appropriate timeout settings, etc when invoking this!",
"operationId" : "updateApiKeysExpiry",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter specifies the type of access token for which expiry date should be updated. Currently only apiAccessKeyCredentials is supported",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AccessTokensTypeModel"
},
"x-examples" : {
"application/json" : "{\"type\":\"apiAccessKeyCredentials\"}"
}
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the access tokens are successfully updated with the new expiry date."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the access tokens are successfully updated with the new expiry date."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/applications/{applicationId}" : {
"get" : {
"description" : "The method retrieves the details of a specified application in API Gateway",
"operationId" : "getApplication",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application whose details are to be retrieved in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the details of the specified application are retrieved successfully.",
"examples" : {
"application/json" : "{\n \"applications\": [\n {\n \"name\": \"TestApp\",\n \"description\": null,\n \"contactEmails\": [],\n \"identifiers\": [\n {\n \"id\": \"820332c8-7467-4340-bef8-dae595c69f7b\",\n \"name\": \"Username\",\n \"key\": \"httpBasicAuth\",\n \"value\": [\n \"admin\"\n ]\n }\n ],\n \"siteURLs\": [],\n \"jsOrigins\": [],\n \"authStrategyIds\": [],\n \"version\": \"1.0\",\n \"id\": \"79251257-1ea5-4df7-a8bf-a345ea835592\",\n \"created\": \"2018-12-04 05:33:20 GMT\",\n \"lastupdated\": null,\n \"owner\": \"Administrator\",\n \"consumingAPIs\": [],\n \"accessTokens\": {\n \"apiAccessKey_credentials\": {\n \"apiAccessKey\": \"eb3fcb16-89bd-4d0b-b45b-c1257686e4d6\",\n \"expirationInterval\": null,\n \"expirationDate\": null,\n \"expired\": false\n },\n \"oauth_credentials\": {\n \"clientID\": null,\n \"clientSecret\": null,\n \"clientName\": null,\n \"scopes\": null,\n \"token_lifetime\": null,\n \"token_refresh_limit\": null,\n \"redirect_uris\": [],\n \"Type\": \"confidential\"\n }\n }\n }\n ]\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the details of the specified application are retrieved successfully.",
"examples" : {
"application/json" : "{\n \"applications\": [\n {\n \"name\": \"TestApp\",\n \"description\": null,\n \"contactEmails\": [],\n \"identifiers\": [\n {\n \"id\": \"820332c8-7467-4340-bef8-dae595c69f7b\",\n \"name\": \"Username\",\n \"key\": \"httpBasicAuth\",\n \"value\": [\n \"admin\"\n ]\n }\n ],\n \"siteURLs\": [],\n \"jsOrigins\": [],\n \"authStrategyIds\": [],\n \"version\": \"1.0\",\n \"id\": \"79251257-1ea5-4df7-a8bf-a345ea835592\",\n \"created\": \"2018-12-04 05:33:20 GMT\",\n \"lastupdated\": null,\n \"owner\": \"Administrator\",\n \"consumingAPIs\": [],\n \"accessTokens\": {\n \"apiAccessKey_credentials\": {\n \"apiAccessKey\": \"eb3fcb16-89bd-4d0b-b45b-c1257686e4d6\",\n \"expirationInterval\": null,\n \"expirationDate\": null,\n \"expired\": false\n },\n \"oauth_credentials\": {\n \"clientID\": null,\n \"clientSecret\": null,\n \"clientName\": null,\n \"scopes\": null,\n \"token_lifetime\": null,\n \"token_refresh_limit\": null,\n \"redirect_uris\": [],\n \"Type\": \"confidential\"\n }\n }\n }\n ]\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"put" : {
"description" : "This HTTP request updates a specified application in API Gateway. You can use this resource to update basic information in application like name, description, version, identifiers, linked authentication strategy ids etc., but you cannot use this method to update the contents of authentication strategies, access tokens or to update associated apis. To regenerate the access tokens (API key), refer the resource /applications/{applicationId}/accessTokens POST. To update the associated apis, refer the resource /applications/{applicationId}/apis PUT. To create new authentication strategies or update the authentication strategies, refer the resource /strategies POST or /strategies/{strategyId} PUT",
"operationId" : "updateApplication",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter describes the request payload of an application that is to be updated in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Application"
},
"x-examples" : {
"application/json" : "{\r\n \"name\": \"TestApp\",\r\n \"description\": \"My Test Application\",\r\n \"version\": \"1.0\",\r\n \"contactEmails\": [],\r\n \"siteURLs\": [],\r\n \"identifiers\": [],\r\n \"consumingAPIs\": [],\r\n \"owner\": \"Administrator\",\r\n \"isSuspended\": false,\r\n \"jsOrigins\": [\r\n \"aaf\",\r\n \"ffd\"\r\n ],\r\n \"authStrategyIds\": [\r\n \"4d5006b8-80b0-4770-9a4f-32f176dd2e59\"\r\n ],\r\n \"requesterComment\": \"Updating the application for so and so reason! Please approve!\"\r\n}"
}
}, {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application that is to be updated in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the specified application has been successfully updated in API Gateway.",
"examples" : {
"application/json" : "{\r\n \"name\": \"TestApp\",\r\n \"description\": \"My Test Application\",\r\n \"contactEmails\": [],\r\n \"identifiers\": [],\r\n \"siteURLs\": [],\r\n \"jsOrigins\": [\r\n \"orgn1\",\r\n \"orgn2\"\r\n ],\r\n \"authStrategyIds\": [\r\n \"4d5006b8-80b0-4770-9a4f-32f176dd2e59\"\r\n ],\r\n \"version\": \"1.0\",\r\n \"id\": \"cf24b278-f126-4e77-bb10-e32e4a7f845e\",\r\n \"created\": \"2019-11-19 12:54:11 GMT\",\r\n \"lastupdated\": \"2019-11-19 15:08:15 GMT\",\r\n \"owner\": \"Administrator\",\r\n \"consumingAPIs\": [],\r\n \"accessTokens\": {\r\n \"apiAccessKey_credentials\": {\r\n \"apiAccessKey\": \"52dd7cf2172f7770a79cb699309eda289af863eb5ba67ce85d2cc7956220988a\",\r\n \"expirationInterval\": null,\r\n \"expirationDate\": null,\r\n \"expired\": false\r\n }\r\n }\r\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"400" : {
"description" : "This status code indicates that the specified application could not be updated"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the specified application has been successfully updated in API Gateway.",
"examples" : {
"application/json" : "{\r\n \"name\": \"TestApp\",\r\n \"description\": \"My Test Application\",\r\n \"contactEmails\": [],\r\n \"identifiers\": [],\r\n \"siteURLs\": [],\r\n \"jsOrigins\": [\r\n \"orgn1\",\r\n \"orgn2\"\r\n ],\r\n \"authStrategyIds\": [\r\n \"4d5006b8-80b0-4770-9a4f-32f176dd2e59\"\r\n ],\r\n \"version\": \"1.0\",\r\n \"id\": \"cf24b278-f126-4e77-bb10-e32e4a7f845e\",\r\n \"created\": \"2019-11-19 12:54:11 GMT\",\r\n \"lastupdated\": \"2019-11-19 15:08:15 GMT\",\r\n \"owner\": \"Administrator\",\r\n \"consumingAPIs\": [],\r\n \"accessTokens\": {\r\n \"apiAccessKey_credentials\": {\r\n \"apiAccessKey\": \"52dd7cf2172f7770a79cb699309eda289af863eb5ba67ce85d2cc7956220988a\",\r\n \"expirationInterval\": null,\r\n \"expirationDate\": null,\r\n \"expired\": false\r\n }\r\n }\r\n}"
},
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"400" : {
"description" : "This status code indicates that the specified application could not be updated"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"delete" : {
"description" : "The method deletes the specified application in API Gateway.",
"operationId" : "deleteApplic",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "This status code indicates that the specified application has been successfully deleted from API Gateway."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"204" : {
"description" : "This status code indicates that the specified application has been successfully deleted from API Gateway."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"patch" : {
"description" : "This HTTP PATCH request suspends the specified application in API Gateway.",
"operationId" : "patchApplication",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter describes the request payload of an application that is to be updated in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Application"
},
"x-examples" : {
"application/json" : "{\"isSuspended\":\"true\"}"
}
}, {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application that is to be updated in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the specified application has been successfully updated in API Gateway.",
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"400" : {
"description" : "This status code indicates that the specified application could not be updated"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the specified application has been successfully updated in API Gateway.",
"schema" : {
"$ref" : "#/definitions/Application"
}
},
"400" : {
"description" : "This status code indicates that the specified application could not be updated"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/applications/{applicationId}/accessTokens" : {
"get" : {
"description" : "The method retrieves a map of access token endpoints for all the authorization servers configured",
"operationId" : "getAccessTokenEndpoints",
"parameters" : [ {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application whose access token endpoints are to be retrieved from API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that a list of access token endpoints for the application are retrieved successfully.",
"examples" : {
"application/json" : "{\n \"local\": {\n \"uris\": {\n \"authorizeUrl\": \"http://vm:5555/invoke/pub.apigateway.oauth2/authorize\",\n \"accessTokenUrl\": \"http://vm:5555/invoke/pub.apigateway.oauth2/getAccessToken\",\n \"refreshTokenUrl\": \"http://vm:5555/invoke/pub.oauth/refreshAccessToken\"\n }\n }\n}"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that a list of access token endpoints for the application are retrieved successfully.",
"examples" : {
"application/json" : "{\n \"local\": {\n \"uris\": {\n \"authorizeUrl\": \"http://vm:5555/invoke/pub.apigateway.oauth2/authorize\",\n \"accessTokenUrl\": \"http://vm:5555/invoke/pub.apigateway.oauth2/getAccessToken\",\n \"refreshTokenUrl\": \"http://vm:5555/invoke/pub.oauth/refreshAccessToken\"\n }\n }\n}"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"post" : {
"description" : "The method regenarates the access tokens of an application. Possible values for type - apiAccessKeyCredentials for API Key regenaration and oAuthCredentials for Oauth credentials regenaration.",
"operationId" : "regenerateAccessTokens",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application for generating the access Tokens in API Gateway.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "This parameter specifies the type of token to be regenerated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AccessTokensTypeModel"
},
"x-examples" : {
"application/json" : "{\"type\":\"apiAccessKeyCredentials\"}"
}
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the access tokens are successfully regenerated for the application in API Gateway."
},
"400" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the access tokens are successfully regenerated for the application in API Gateway."
},
"400" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/applications/{applicationId}/apis" : {
"get" : {
"description" : "The method retrieves a list of registered APIs for the specified application in API Gateway.",
"operationId" : "getRegisteredApis",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application whose registered APIs are to be retrieved in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that a list of registered APIs for the application is retrieved successfully.",
"examples" : {
"application/json" : "{\n \"apiIDs\": [\n \"2aa651f4-2696-425b-96c4-440ad78b0305\"\n ]\n}"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that a list of registered APIs for the application is retrieved successfully.",
"examples" : {
"application/json" : "{\n \"apiIDs\": [\n \"2aa651f4-2696-425b-96c4-440ad78b0305\"\n ]\n}"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"post" : {
"description" : "This method is to be used to update the registered APIs list for an application. To add a new api to an application which is already registered with other APIs, you should send the complete list of apiIds including the old apiIds and the new apiId(s) to be added. To remove all APIs from the application, send an empty array for the apiIds field in the request.",
"operationId" : "registerApis",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter specifies the IDs of the APIs for registering in an application in API Gateway.",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"x-examples" : {
"application/json" : "{\r\n\t\"apiIDs\": [\r\n\t\t\"3de85431-d45b-418d-b5aa-0be5c3b5714d\",\r\n\t\t\"375db639-01f7-4488-b14f-09daae622e18\"\r\n\t]\r\n}"
}
}, {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application for registering APIs in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the given APIs have been successfully registered with the specified application in API Gateway."
},
"400" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the given APIs have been successfully registered with the specified application in API Gateway."
},
"400" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"put" : {
"description" : "This method is to be used to update the registered APIs list for an application. To add a new api to an application which is already registered with other APIs, you should send the complete list of apiIds including the old apiIds and the new apiId(s) to be added. To remove all APIs from the application, send an empty array for the apiIds field in the request.",
"operationId" : "updateRegisteredApis",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter specifies the ID of a registered API that is to be updated in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RegisterAPIModel"
},
"x-examples" : {
"application/json" : "{\r\n\t\"apiIDs\": [\r\n\t\t\"3de85431-d45b-418d-b5aa-0be5c3b5714d\",\r\n\t\t\"375db639-01f7-4488-b14f-09daae622e18\"\r\n\t]\r\n}"
}
}, {
"name" : "applicationId",
"in" : "path",
"description" : "This parameter specifies the ID of an application for updating the details of the registered APIs in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the registered API has been successfully updated in API Gateway."
},
"400" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the registered API has been successfully updated in API Gateway."
},
"400" : {
"description" : "This status code indicates that an application with the given ID could not be found in API Gateway."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/strategies" : {
"get" : {
"description" : "The method retrieves a list of all strategies in API Gateway.",
"operationId" : "getStrategies",
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "This status code indicates that the list of strategies is successfully retrieved.",
"examples" : {
"application/json" : "{\n \"strategies\": [\n {\n \"id\": \"e1f151e1-3210-4283-992b-b3f1d1cf6a92\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"test-oauth2-strategy\",\n \"description\": \"\",\n \"clientId\": \"e65b0fe2-d73d-4ea7-a92a-20c949e08235\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"authorization_code\",\n \"password\"\n ],\n \"applicationType\": \"WEB\",\n \"clientType\": \"PUBLIC\",\n \"clientName\": \"test-oauth2-strategy\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"refreshCount\": \"0\",\n \"redirectUris\": [\n \"https://redirect.uri\"\n ]\n },\n \"clientRegistration\": {\n \"clientId\": \"e65b0fe2-d73d-4ea7-a92a-20c949e08235\",\n \"name\": \"test-oauth2-strategy\",\n \"version\": \"1.0\",\n \"type\": \"public\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"f3d2edb1-0bf4-47a8-9e34-775c1a943e70\",\n \"enabled\": true,\n \"redirectUris\": [\n \"https://redirect.uri\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": false,\n \"clientCredentialsAllowed\": false,\n \"resourceOwnerAllowed\": true\n }\n }\n ]\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the list of strategies is successfully retrieved.",
"examples" : {
"application/json" : "{\n \"strategies\": [\n {\n \"id\": \"e1f151e1-3210-4283-992b-b3f1d1cf6a92\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"test-oauth2-strategy\",\n \"description\": \"\",\n \"clientId\": \"e65b0fe2-d73d-4ea7-a92a-20c949e08235\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"authorization_code\",\n \"password\"\n ],\n \"applicationType\": \"WEB\",\n \"clientType\": \"PUBLIC\",\n \"clientName\": \"test-oauth2-strategy\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"refreshCount\": \"0\",\n \"redirectUris\": [\n \"https://redirect.uri\"\n ]\n },\n \"clientRegistration\": {\n \"clientId\": \"e65b0fe2-d73d-4ea7-a92a-20c949e08235\",\n \"name\": \"test-oauth2-strategy\",\n \"version\": \"1.0\",\n \"type\": \"public\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"f3d2edb1-0bf4-47a8-9e34-775c1a943e70\",\n \"enabled\": true,\n \"redirectUris\": [\n \"https://redirect.uri\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": false,\n \"clientCredentialsAllowed\": false,\n \"resourceOwnerAllowed\": true\n }\n }\n ]\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"post" : {
"description" : "The method creates a strategy in API Gateway. The API request body must contain the payload for the strategy",
"operationId" : "createStrategy",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter describes the request payload of a strategy that is to be created in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StrategyRequest"
},
"x-examples" : {
"application/json" : "{\n\"name\": \"Test\",\n\"description\": \"\",\n\"authServerAlias\": \"local\",\n\"type\": \"OAUTH2\",\n\"dcrConfig\": {\n\"allowedGrantTypes\": [\"authorization_code\",\n\"password\",\n\"implicit\"],\n\"scopes\": [],\n\"redirectUris\": [\"http://vm:5555/redirect\"],\n\"authServer\": \"local\",\n\"applicationType\": \"WEB\",\n\"clientType\": \"PUBLIC\",\n\"expirationInterval\": 3600,\n\"refreshCount\": \"0\"\n}\n} "
}
} ],
"responses" : {
"200" : {
"description" : "The method creates a strategy in API Gateway. The API request body must contain the payload for the strategy",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"370f88ca-205e-45df-8e16-998088f32dc2\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"Test\",\n \"description\": \"\",\n \"clientId\": \"2b54de1c-a8fa-4965-a832-cacf6b656012\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"authorization_code\",\n \"password\",\n \"implicit\"\n ],\n \"applicationType\": \"WEB\",\n \"clientType\": \"PUBLIC\",\n \"clientName\": \"Test\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"refreshCount\": \"0\",\n \"redirectUris\": [\n \"http://vm:5555/redirect\"\n ]\n },\n \"clientRegistration\": {\n \"clientId\": \"2b54de1c-a8fa-4965-a832-cacf6b656012\",\n \"name\": \"Test\",\n \"version\": \"1.0\",\n \"type\": \"public\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"6a3d98c3-e5b0-47fc-9acf-b454401cd87d\",\n \"enabled\": true,\n \"redirectUris\": [\n \"http://vm:5555/redirect\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": false,\n \"resourceOwnerAllowed\": true\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"400" : {
"description" : "This status code indicates that a strategy with the given ID already exists in API Gateway"
},
"401" : {
"description" : "This status code indicates that either the user didn't provide right credentials or the user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "The method creates a strategy in API Gateway. The API request body must contain the payload for the strategy",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"370f88ca-205e-45df-8e16-998088f32dc2\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"Test\",\n \"description\": \"\",\n \"clientId\": \"2b54de1c-a8fa-4965-a832-cacf6b656012\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"authorization_code\",\n \"password\",\n \"implicit\"\n ],\n \"applicationType\": \"WEB\",\n \"clientType\": \"PUBLIC\",\n \"clientName\": \"Test\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"refreshCount\": \"0\",\n \"redirectUris\": [\n \"http://vm:5555/redirect\"\n ]\n },\n \"clientRegistration\": {\n \"clientId\": \"2b54de1c-a8fa-4965-a832-cacf6b656012\",\n \"name\": \"Test\",\n \"version\": \"1.0\",\n \"type\": \"public\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"6a3d98c3-e5b0-47fc-9acf-b454401cd87d\",\n \"enabled\": true,\n \"redirectUris\": [\n \"http://vm:5555/redirect\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": false,\n \"resourceOwnerAllowed\": true\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"400" : {
"description" : "This status code indicates that a strategy with the given ID already exists in API Gateway"
},
"401" : {
"description" : "This status code indicates that either the user didn't provide right credentials or the user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/strategies/{strategyId}" : {
"get" : {
"description" : "The method retrieves the details of a specified strategy in API Gateway",
"operationId" : "getStrategy",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "strategyId",
"in" : "path",
"description" : "This parameter specifies the ID of a strategy whose details are to be retrieved in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the details of the specified strategy are retrieved successfully.",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"a2641013-701c-420d-9eba-30cd9da1f0f5\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [\n \"https://placeholder_redirect_uri\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that a strategy with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the details of the specified strategy are retrieved successfully.",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"a2641013-701c-420d-9eba-30cd9da1f0f5\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [\n \"https://placeholder_redirect_uri\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that a strategy with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"put" : {
"description" : "This REST operation is used to update a strategy",
"operationId" : "updateStrategy",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "This parameter describes the request payload of a strategy that is to be updated in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StrategyRequest"
},
"x-examples" : {
"application/json" : " {\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [\n \"https://placeholder_redirect_uri\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n"
}
}, {
"name" : "strategyId",
"in" : "path",
"description" : "This parameter specifies the ID of a strategy that is to be updated in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the specified strategy has been successfully updated in API Gateway.",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"a2641013-701c-420d-9eba-30cd9da1f0f5\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"400" : {
"description" : "This status code indicates that the specified strategy could not be updated"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the specified strategy has been successfully updated in API Gateway.",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"a2641013-701c-420d-9eba-30cd9da1f0f5\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"400" : {
"description" : "This status code indicates that the specified strategy could not be updated"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"delete" : {
"description" : "The method deletes the specified strategy in API Gateway.",
"operationId" : "deleteStrategy",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "strategyId",
"in" : "path",
"description" : "This parameter specifies the ID of a strategy that is to be deleted in API Gateway.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "This status code indicates that the specified strategy has been successfully deleted from API Gateway."
},
"401" : {
"description" : "This status code indicates that either the user didn't provide right credentials or the user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that a strategy with the given ID could not be found in API Gateway."
}
},
"responsesObject" : {
"204" : {
"description" : "This status code indicates that the specified strategy has been successfully deleted from API Gateway."
},
"401" : {
"description" : "This status code indicates that either the user didn't provide right credentials or the user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that a strategy with the given ID could not be found in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/strategies/{strategyId}/refreshCredentials" : {
"put" : {
"description" : "The method refreshes the credentials of a strategy in API Gateway. This is applicable only when dynamic client registration (generate credentials) is enabled in the strategy.",
"operationId" : "refreshCredentials",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "strategyId",
"in" : "path",
"description" : "This parameter specifies the ID of a strategy that is to be updated in API Gateway.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "This parameter describes the request payload for the strategy to be refreshed in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StrategyRequest"
},
"x-examples" : {
"application/json" : " {\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [\n \"https://placeholder_redirect_uri\"\n ],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n"
}
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the specified strategy has been successfully updated in API Gateway",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"a2641013-701c-420d-9eba-30cd9da1f0f5\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"400" : {
"description" : "This status code indicates that the specified strategy could not be refreshed"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"responsesObject" : {
"200" : {
"description" : "This status code indicates that the specified strategy has been successfully updated in API Gateway",
"examples" : {
"application/json" : "{\n \"strategy\": {\n \"id\": \"a2641013-701c-420d-9eba-30cd9da1f0f5\",\n \"type\": \"OAUTH2\",\n \"authServerAlias\": \"local\",\n \"name\": \"testapp-$sys-default-oauth\",\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"dcrConfig\": {\n \"allowedGrantTypes\": [\n \"implicit\",\n \"client_credentials\",\n \"authorization_code\"\n ],\n \"clientType\": \"CONFIDENTIAL\",\n \"clientName\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"clientVersion\": \"1.0\",\n \"expirationInterval\": \"3600\",\n \"redirectUris\": []\n },\n \"clientRegistration\": {\n \"clientId\": \"5b5e2fee-b786-4abe-9fd4-584c265d260a\",\n \"name\": \"4425af88-a80d-4f6c-b6e0-84008c720889\",\n \"version\": \"1.0\",\n \"type\": \"confidential\",\n \"tokenLifetime\": 3600,\n \"tokenRefreshLimit\": 0,\n \"clientSecret\": \"1bd1bcd0-7eb2-4aa9-a50a-41c038ad92b2\",\n \"enabled\": true,\n \"redirectUris\": [],\n \"clScopes\": [],\n \"authCodeAllowed\": true,\n \"implicitAllowed\": true,\n \"clientCredentialsAllowed\": true,\n \"resourceOwnerAllowed\": false\n }\n }\n}"
},
"schema" : {
"$ref" : "#/definitions/OneOfStrategyModel"
}
},
"400" : {
"description" : "This status code indicates that the specified strategy could not be refreshed"
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
}
},
"securityDefinitions" : {
"Basic" : {
"description" : "API Gateway Administrator and API Gateway provider",
"type" : "basic"
}
},
"definitions" : {
"APIAccessKey" : {
"type" : "object",
"properties" : {
"apiAccessKey" : {
"type" : "string",
"description" : "API access key"
},
"expirationDate" : {
"type" : "string",
"description" : "expiration date of the api key"
},
"expirationInterval" : {
"type" : "string",
"description" : "expiration interval of the api key"
}
}
},
"AccessTokensTypeModel" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
}
}
},
"Application" : {
"type" : "object",
"properties" : {
"accessTokens" : {
"$ref" : "#/definitions/ApplicationToken"
},
"applicationID" : {
"type" : "string",
"description" : "unique identifier of an application"
},
"authStrategyIds" : {
"type" : "array",
"description" : "Contains a list of JWT/Oauth/OpenID authentication strategy ids associated to the application",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"contactEmails" : {
"type" : "array",
"description" : "list of email contacts",
"items" : {
"type" : "string"
}
},
"creationDate" : {
"type" : "string",
"description" : "application creation time"
},
"customFields" : {
"type" : "object",
"description" : "list of all custom fields",
"additionalProperties" : {
"type" : "object"
}
},
"description" : {
"type" : "string",
"description" : "description of the application"
},
"iconbyteArray" : {