-
-
Notifications
You must be signed in to change notification settings - Fork 579
/
openapi.yaml
8564 lines (8564 loc) · 212 KB
/
openapi.yaml
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
openapi: 3.0.2
servers:
- url: http://keycloak.local
info:
description: This is a REST API reference for the Keycloak Admin
title: Keycloak Admin REST API
version: "1"
x-apisguru-categories:
- developer_tools
x-origin:
- format: openapi
url: https://raw.githubusercontent.com/ccouzens/keycloak-openapi/master/keycloak/10.0.json
version: "3.0"
x-providerName: keycloak.local
externalDocs:
description: Schema source code
url: https://github.com/keycloak/keycloak/tree/6.0.1/core/src/main/java/org/keycloak/representations
security:
- access_token: []
paths:
/:
get:
responses:
2XX:
content:
application/json:
schema:
$ref: "#/components/schemas/ServerInfoRepresentation"
description: success
summary: Get themes, social providers, auth providers, and event listeners available on this server
tags:
- Root
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RealmRepresentation"
description: JSON representation of the realm
required: true
responses:
2XX:
description: success
summary: Import a realm Imports a realm from a full representation of that realm.
tags:
- Realms Admin
"/{id}/name":
get:
responses:
2XX:
content:
application/json:
schema:
additionalProperties: true
type: object
description: success
summary: Need this for admin console to display simple name of provider when displaying client detail KEYCLOAK-4328
tags:
- User Storage Provider
parameters:
- in: path
name: id
required: true
schema:
type: string
style: simple
"/{realm}":
delete:
responses:
2XX:
description: success
summary: Delete the realm
tags:
- Realms Admin
get:
responses:
2XX:
content:
application/json:
schema:
$ref: "#/components/schemas/RealmRepresentation"
description: success
summary: Get the top-level representation of the realm It will not include nested information like User and Client representations.
tags:
- Realms Admin
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
put:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RealmRepresentation"
required: true
responses:
2XX:
description: success
summary: Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.
tags:
- Realms Admin
"/{realm}/admin-events":
delete:
responses:
2XX:
description: success
summary: Delete all admin events
tags:
- Realms Admin
get:
parameters:
- in: query
name: authClient
schema:
type: string
style: form
- in: query
name: authIpAddress
schema:
type: string
style: form
- in: query
name: authRealm
schema:
type: string
style: form
- description: user id
in: query
name: authUser
schema:
type: string
style: form
- in: query
name: dateFrom
schema:
type: string
style: form
- in: query
name: dateTo
schema:
type: string
style: form
- in: query
name: first
schema:
format: int32
type: integer
style: form
- description: Maximum results size (defaults to 100)
in: query
name: max
schema:
format: int32
type: integer
style: form
- in: query
name: operationTypes
schema:
items:
type: string
type: array
style: form
- in: query
name: resourcePath
schema:
type: string
style: form
- in: query
name: resourceTypes
schema:
items:
type: string
type: array
style: form
responses:
2XX:
content:
application/json:
schema:
items:
$ref: "#/components/schemas/AdminEventRepresentation"
type: array
description: success
summary: Get admin events Returns all admin events, or filters events based on URL query parameters listed here
tags:
- Realms Admin
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/attack-detection/brute-force/users":
delete:
responses:
2XX:
description: success
summary: Clear any user login failures for all users This can release temporary disabled users
tags:
- Attack Detection
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/attack-detection/brute-force/users/{userId}":
delete:
responses:
2XX:
description: success
summary: Clear any user login failures for the user This can release temporary disabled user
tags:
- Attack Detection
get:
responses:
2XX:
content:
application/json:
schema:
additionalProperties: true
type: object
description: success
summary: Get status of a username in brute force detection
tags:
- Attack Detection
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- in: path
name: userId
required: true
schema:
type: string
style: simple
"/{realm}/authentication/authenticator-providers":
get:
responses:
2XX:
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
description: success
summary: Get authenticator providers Returns a list of authenticator providers.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/authentication/client-authenticator-providers":
get:
responses:
2XX:
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
description: success
summary: Get client authenticator providers Returns a list of client authenticator providers.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/authentication/config-description/{providerId}":
get:
responses:
2XX:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticatorConfigInfoRepresentation"
description: success
summary: Get authenticator provider’s configuration description
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- in: path
name: providerId
required: true
schema:
type: string
style: simple
"/{realm}/authentication/config/{id}":
delete:
responses:
2XX:
description: success
summary: Delete authenticator configuration
tags:
- Authentication Management
get:
responses:
2XX:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticatorConfigRepresentation"
description: success
summary: Get authenticator configuration
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Configuration id
in: path
name: id
required: true
schema:
type: string
style: simple
put:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticatorConfigRepresentation"
description: JSON describing new state of authenticator configuration
required: true
responses:
2XX:
description: success
summary: Update authenticator configuration
tags:
- Authentication Management
"/{realm}/authentication/executions":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationExecutionRepresentation"
description: JSON model describing authentication execution
required: true
responses:
2XX:
description: success
summary: Add new authentication execution
tags:
- Authentication Management
"/{realm}/authentication/executions/{executionId}":
delete:
responses:
2XX:
description: success
summary: Delete execution
tags:
- Authentication Management
get:
responses:
2XX:
description: success
summary: Get Single Execution
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Execution id
in: path
name: executionId
required: true
schema:
type: string
style: simple
"/{realm}/authentication/executions/{executionId}/config":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Execution id
in: path
name: executionId
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticatorConfigRepresentation"
description: JSON with new configuration
required: true
responses:
2XX:
description: success
summary: Update execution with new configuration
tags:
- Authentication Management
"/{realm}/authentication/executions/{executionId}/lower-priority":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Execution id
in: path
name: executionId
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Lower execution’s priority
tags:
- Authentication Management
"/{realm}/authentication/executions/{executionId}/raise-priority":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Execution id
in: path
name: executionId
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Raise execution’s priority
tags:
- Authentication Management
"/{realm}/authentication/flows":
get:
responses:
2XX:
content:
application/json:
schema:
items:
$ref: "#/components/schemas/AuthenticationFlowRepresentation"
type: array
description: success
summary: Get authentication flows Returns a list of authentication flows.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationFlowRepresentation"
description: Authentication flow representation
required: true
responses:
2XX:
description: success
summary: Create a new authentication flow
tags:
- Authentication Management
"/{realm}/authentication/flows/{flowAlias}/copy":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Name of the existing authentication flow
in: path
name: flowAlias
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
description: JSON containing 'newName' attribute
required: true
responses:
2XX:
description: success
summary: Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object
tags:
- Authentication Management
"/{realm}/authentication/flows/{flowAlias}/executions":
get:
responses:
2XX:
description: success
summary: Get authentication executions for a flow
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Flow alias
in: path
name: flowAlias
required: true
schema:
type: string
style: simple
put:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationExecutionInfoRepresentation"
required: true
responses:
2XX:
description: success
summary: Update authentication executions of a flow
tags:
- Authentication Management
"/{realm}/authentication/flows/{flowAlias}/executions/execution":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Alias of parent flow
in: path
name: flowAlias
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
description: New execution JSON data containing 'provider' attribute
required: true
responses:
2XX:
description: success
summary: Add new authentication execution to a flow
tags:
- Authentication Management
"/{realm}/authentication/flows/{flowAlias}/executions/flow":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Alias of parent authentication flow
in: path
name: flowAlias
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
description: New authentication flow / execution JSON data containing 'alias', 'type', 'provider', and 'description' attributes
required: true
responses:
2XX:
description: success
summary: Add new flow with new execution to existing flow
tags:
- Authentication Management
"/{realm}/authentication/flows/{id}":
delete:
responses:
2XX:
description: success
summary: Delete an authentication flow
tags:
- Authentication Management
get:
responses:
2XX:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationFlowRepresentation"
description: success
summary: Get authentication flow for id
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Flow id
in: path
name: id
required: true
schema:
type: string
style: simple
put:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationFlowRepresentation"
description: Authentication flow representation
required: true
responses:
2XX:
description: success
summary: Update an authentication flow
tags:
- Authentication Management
"/{realm}/authentication/form-action-providers":
get:
responses:
2XX:
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
description: success
summary: Get form action providers Returns a list of form action providers.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/authentication/form-providers":
get:
responses:
2XX:
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
description: success
summary: Get form providers Returns a list of form providers.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/authentication/per-client-config-description":
get:
responses:
2XX:
content:
application/json:
schema:
additionalProperties: true
type: object
description: success
summary: Get configuration descriptions for all clients
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/authentication/register-required-action":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
description: JSON containing 'providerId', and 'name' attributes.
required: true
responses:
2XX:
description: success
summary: Register a new required actions
tags:
- Authentication Management
"/{realm}/authentication/required-actions":
get:
responses:
2XX:
content:
application/json:
schema:
items:
$ref: "#/components/schemas/RequiredActionProviderRepresentation"
type: array
description: success
summary: Get required actions Returns a list of required actions.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/authentication/required-actions/{alias}":
delete:
responses:
2XX:
description: success
summary: Delete required action
tags:
- Authentication Management
get:
responses:
2XX:
content:
application/json:
schema:
$ref: "#/components/schemas/RequiredActionProviderRepresentation"
description: success
summary: Get required action for alias
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Alias of required action
in: path
name: alias
required: true
schema:
type: string
style: simple
put:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RequiredActionProviderRepresentation"
description: JSON describing new state of required action
required: true
responses:
2XX:
description: success
summary: Update required action
tags:
- Authentication Management
"/{realm}/authentication/required-actions/{alias}/lower-priority":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Alias of required action
in: path
name: alias
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Lower required action’s priority
tags:
- Authentication Management
"/{realm}/authentication/required-actions/{alias}/raise-priority":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
- description: Alias of required action
in: path
name: alias
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Raise required action’s priority
tags:
- Authentication Management
"/{realm}/authentication/unregistered-required-actions":
get:
responses:
2XX:
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
description: success
summary: Get unregistered required actions Returns a list of unregistered required actions.
tags:
- Authentication Management
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
"/{realm}/clear-keys-cache":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Clear cache of external public keys (Public keys of clients or Identity providers)
tags:
- Realms Admin
"/{realm}/clear-realm-cache":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Clear realm cache
tags:
- Realms Admin
"/{realm}/clear-user-cache":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
responses:
2XX:
description: success
summary: Clear user cache
tags:
- Realms Admin
"/{realm}/client-description-converter":
parameters:
- description: realm name (not id!)
in: path
name: realm
required: true
schema:
type: string
style: simple
post:
requestBody: