forked from common-fate/glide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
3061 lines (3051 loc) · 84.2 KB
/
openapi.yml
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.0
info:
title: Common Fate
version: "1.0"
contact:
name: Common Fate
url: "https://commonfate.io"
description: Common Fate API
servers:
- url: "http://localhost:8080"
paths:
/api/v1/access-rules:
get:
summary: List Access Rules
tags:
- End User
responses:
"200":
$ref: "#/components/responses/ListAccessRulesResponse"
operationId: user-list-access-rules
description: Get all access rules as an end user.
"/api/v1/access-rules/{ruleId}":
get:
summary: Get Access Rule
tags:
- End User
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestAccessRule"
"401":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
operationId: user-get-access-rule
description: |-
Get details for an Access Rule.
End users are only able to view Access Rules if they are a member of the group the rule relates to, or if they are designated as an approver for the Access Rule. If a user doesn't meet these conditions, a HTTP401 unauthorized error is returned.
parameters:
- schema:
type: string
name: ruleId
in: path
required: true
"/api/v1/access-rules/{ruleId}/approvers":
get:
summary: List Access Rule approvers
tags:
- End User
responses:
"200":
$ref: "#/components/responses/ListAccessRuleApproversResponse"
"401":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
operationId: user-get-access-rule-approvers
description: |-
Get the approvers for an access rule.
This returns a list of user IDs.
End users are only able to view Access Rules if they are a member of the group the rule relates to, or if they are designated as an approver for the Access Rule. If a user doesn't meet these conditions, a HTTP401 unauthorized error is returned.
parameters:
- schema:
type: string
name: ruleId
in: path
required: true
/api/v1/requests:
get:
summary: List my requests
tags:
- End User
responses:
"200":
$ref: "#/components/responses/ListRequestsResponse"
operationId: user-list-requests
description: |-
List requests.
The reviewer query param allows you to fetch requests which you can review.
parameters:
- schema:
type: string
enum:
- APPROVED
- DECLINED
- CANCELLED
- PENDING
in: query
name: status
description: omit this param to view all results
- schema:
type: boolean
in: query
name: reviewer
description: "show requests that the user is a reviewer for, rather than requests that the user has made themselves"
- schema:
type: string
in: query
name: nextToken
description: encrypted token containing pagination info
parameters: []
post:
summary: Create a request
operationId: user-create-request
responses:
"200":
$ref: "#/components/responses/CreateRequestResponse"
description: |-
Make a request to access something.
Users must specify an Access Rule when making a request. Users are authorized to make a request if they are in a group that the Access Rule references. Otherwise, a HTTP 404 response will be returned.
requestBody:
$ref: "#/components/requestBodies/CreateRequestRequest"
tags:
- End User
/api/v1/requests/upcoming:
get:
summary: Your GET endpoint
tags:
- End User
responses:
"200":
$ref: "#/components/responses/ListRequestsResponse"
operationId: user-list-requests-upcoming
description: Display pending requests and approved requests that are currently active or scheduled to begin some time in future.
parameters:
- schema:
type: string
in: query
description: encrypted token containing pagination info
name: nextToken
/api/v1/requests/past:
get:
summary: Your GET endpoint
tags:
- End User
responses:
"200":
$ref: "#/components/responses/ListRequestsResponse"
operationId: user-list-requests-past
description: |
Display show cancelled, expired, and revoked requests.
parameters:
- schema:
type: string
in: query
name: nextToken
description: encrypted token containing pagination info
"/api/v1/requests/{requestId}":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
get:
summary: Get a request
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestDetail"
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: user-get-request
description: |-
Returns a HTTP401 response if the user is not the requestor or a reviewer.
Use /api/v1/admin/requests/{requestId} as an administrator to view information for requests not made by the current user (note: requires that the user is a Common Fate administrator).
tags:
- End User
parameters: []
"/api/v1/requests/{requestId}/events":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
get:
summary: List request events
responses:
"200":
$ref: "#/components/responses/ListRequestEventsResponse"
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: user-list-request-events
description: |
Returns a HTTP401 response if the user is not the requestor or a reviewer.
tags:
- End User
parameters: []
"/api/v1/requests/{requestId}/review":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
post:
summary: Review a request
operationId: user-review-request
responses:
"200":
$ref: "#/components/responses/ReviewResponse"
tags:
- End User
description: "Review an access request made by a user. The reviewing user must be an approver for a request. Users cannot review their own requests, even if they are an approver for the Access Rule."
requestBody:
$ref: "#/components/requestBodies/ReviewRequest"
"/api/v1/requests/{requestId}/cancel":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
post:
summary: Cancel a request
operationId: user-cancel-request
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties: {}
"400":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
tags:
- End User
description: Users can cancel an access request that they have created while it is in the PENDING state.
"/api/v1/requests/{requestid}/revoke":
parameters:
- schema:
type: string
name: requestid
in: path
required: true
post:
summary: Revoke an active request
operationId: user-revoke-request
responses:
"200":
description: OK
"400":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
tags:
- End User
description: "Admins and approvers can revoke access previously approved. Effective immediately "
"/api/v1/requests/{requestId}/access-instructions":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
get:
summary: Get Access Instructions
tags:
- End User
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: ./accesshandler/openapi.yml#/components/schemas/AccessInstructions
operationId: user-get-access-instructions
description: |-
Get access instructions for a request.
Returns information on how to access the role or resource.
"/api/v1/requests/{requestId}/access-token":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
get:
summary: Get Access Token
tags:
- End User
responses:
"200":
$ref: "#/components/responses/AccessTokenResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: user-get-access-token
description: |-
Get access token for a request.
Returns information on how to access the role or resource.
"/api/v1/users/{userId}":
parameters:
- schema:
type: string
name: userId
in: path
required: true
get:
summary: Get a user
tags:
- End User
operationId: user-get-user
description: Returns a Common Fate user.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"401":
description: Unauthorized
"404":
description: Not Found
/api/v1/users/me:
get:
summary: Get details for the current user
tags:
- End User
operationId: user-get-me
description: Returns information about the currently logged in user.
responses:
"200":
$ref: "#/components/responses/AuthUserResponse"
"401":
description: Unauthorized
/api/v1/admin/access-rules:
get:
summary: List Access Rules
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ListAccessRulesDetailResponse"
operationId: admin-list-access-rules
description: List all access rules
parameters:
- schema:
type: string
enum:
- ACTIVE
- ARCHIVED
in: query
name: status
description: Filter Access Rules by a particular status.
- schema:
type: string
in: query
name: nextToken
description: encrypted token containing pagination info
post:
summary: Create Access Rule
operationId: admin-create-access-rule
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/AccessRuleDetail"
"400":
$ref: "#/components/responses/ErrorResponse"
"401":
$ref: "#/components/responses/ErrorResponse"
description: Create an access rule
requestBody:
$ref: "#/components/requestBodies/CreateAccessRuleRequest"
tags:
- Admin
parameters: []
"/api/v1/admin/access-rules/{ruleId}":
get:
summary: Get Access Rule
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/AccessRuleDetail"
"401":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-get-access-rule
description: Get an Access Rule.
parameters:
- schema:
type: string
name: ruleId
in: path
required: true
put:
summary: Update Access Rule
operationId: admin-update-access-rule
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/AccessRuleDetail"
"400":
description: Bad Request
"401":
description: Unauthorized
"404":
description: Not Found
"500":
description: Internal Server Error
requestBody:
$ref: "#/components/requestBodies/CreateAccessRuleRequest"
description: Updates an Access Rule. Updating a rule creates a new version.
tags:
- Admin
"/api/v1/admin/access-rules/{ruleId}/archive":
parameters:
- schema:
type: string
name: ruleId
in: path
required: true
post:
summary: Archive Access Rule
operationId: admin-archive-access-rule
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/AccessRuleDetail"
"401":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
description: |-
Marks an access rule as archived.
Any pending requests for this access rule will be cancelled.
"/api/v1/admin/access-rules/{ruleId}/versions":
get:
summary: Get Access Rule version history
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ListAccessRulesDetailResponse"
"401":
description: Unauthorized
"404":
description: Not Found
operationId: admin-get-access-rule-versions
description: Returns a version history for a particular Access Rule.
parameters:
- schema:
type: string
name: ruleId
in: path
required: true
"/api/v1/admin/access-rules/{ruleId}/versions/{version}":
get:
summary: Get Access Rule Version
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/AccessRuleDetail"
"401":
$ref: "#/components/responses/ErrorResponse"
"404":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-get-access-rule-version
description: Returns a specific version for an Access Rule.
parameters:
- schema:
type: string
name: ruleId
in: path
required: true
- schema:
type: string
name: version
in: path
required: true
/api/v1/admin/deployment/version:
get:
summary: Get deployment version details
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/DeploymentVersionResponse"
operationId: admin-get-deployment-version
description: Returns the version information
parameters: []
/api/v1/admin/requests:
get:
summary: Your GET endpoint
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ListRequestsResponse"
operationId: admin-list-requests
description: Return a list of all requests
parameters:
- schema:
type: string
enum:
- APPROVED
- DECLINED
- CANCELLED
- PENDING
in: query
description: omit this param to view all results
name: status
- schema:
type: string
in: query
name: nextToken
description: encrypted token containing pagination info
"/api/v1/admin/requests/{requestId}":
parameters:
- schema:
type: string
name: requestId
in: path
required: true
get:
summary: Get a request
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestDetail"
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-get-request
description: Returns an access request.
tags:
- End User
parameters: []
"/api/v1/admin/users/{userId}":
parameters:
- schema:
type: string
name: userId
in: path
required: true
post:
summary: Update User
operationId: admin-update-user
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"400":
$ref: "#/components/responses/ErrorResponse"
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
description: Update a user including group membership
requestBody:
content:
application/json:
schema:
type: object
properties:
groups:
type: array
items:
type: string
required:
- groups
tags:
- Admin
/api/v1/admin/users:
get:
summary: Returns a list of users
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ListUserResponse"
operationId: admin-list-users
description: Fetch a list of users
parameters:
- schema:
type: string
in: query
name: nextToken
description: encrypted token containing pagination info
post:
summary: Create User
operationId: admin-create-user
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"400":
$ref: "#/components/responses/ErrorResponse"
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
description: Create new user in the Cognito user pool if it is enabled.
requestBody:
$ref: "#/components/requestBodies/CreateUserRequest"
tags:
- Admin
/api/v1/admin/groups:
get:
summary: List groups
tags:
- Admin
operationId: admin-list-groups
description: Lists all active groups
responses:
"200":
$ref: "#/components/responses/ListGroupsResponse"
parameters:
- schema:
type: string
in: query
name: nextToken
description: encrypted token containing pagination info
- schema:
type: string
enum:
- INTERNAL
- EXTERNAL
in: query
name: source
parameters: []
post:
summary: Create Group
operationId: admin-create-group
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/Group"
"400":
$ref: "#/components/responses/ErrorResponse"
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
description: Create new group in the Cognito user pool if it is enabled.
requestBody:
$ref: "#/components/requestBodies/CreateGroupRequest"
tags:
- Admin
"/api/v1/admin/groups/{groupId}":
parameters:
- schema:
type: string
name: groupId
in: path
required: true
get:
summary: Get Group Details
tags:
- Admin
operationId: admin-get-group
description: Returns information for a group.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Group"
put:
summary: Update Group
operationId: admin-update-group
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Group"
"400":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
requestBody:
$ref: "#/components/requestBodies/CreateGroupRequest"
description: Update a group
tags:
- Admin
delete:
summary: Delete Group
operationId: admin-delete-group
tags:
- Admin
responses:
"200":
description: OK
"404":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
description: Delete an internal group
/api/v1/admin/providers:
get:
summary: List providers
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Provider"
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-list-providers
description: List providers
parameters: []
"/api/v1/admin/providers/{providerId}":
get:
summary: List providers
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Provider"
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-get-provider
description: Get provider by id
parameters:
- schema:
type: string
name: providerId
in: path
required: true
"/api/v1/admin/providers/{providerId}/args":
parameters:
- schema:
type: string
name: providerId
in: path
required: true
get:
summary: Get provider arg schema
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: ./accesshandler/openapi.yml#/components/schemas/ArgSchema
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-get-provider-args
description: Gets the argSchema describing the args for this provider
"/api/v1/admin/providers/{providerId}/args/{argId}/options":
parameters:
- schema:
type: string
name: providerId
in: path
required: true
- schema:
type: string
name: argId
in: path
required: true
get:
summary: List provider arg options
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: ./accesshandler/openapi.yml#/components/schemas/ArgOptions
"401":
$ref: "#/components/responses/ErrorResponse"
"500":
$ref: "#/components/responses/ErrorResponse"
operationId: admin-list-provider-arg-options
description: "Returns the options for a particular Access Provider argument. The options may be cached. To refresh the cache, pass the `refresh` query parameter."
parameters:
- schema:
type: boolean
in: query
name: refresh
description: invalidate the cache and refresh the provider's options.
/api/v1/admin/providersetups:
get:
summary: List the provider setups in progress
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ListProviderSetupsResponse"
operationId: admin-list-providersetups
description: List providers which are still in the process of being set up.
parameters: []
post:
summary: Begin the setup process for a new Access Provider
operationId: admin-create-providersetup
tags:
- Admin
responses:
"201":
$ref: "#/components/responses/ProviderSetupResponse"
"400":
$ref: "#/components/responses/ErrorResponse"
description: Begins the guided setup process for a new Access Provider.
requestBody:
$ref: "#/components/requestBodies/CreateProviderSetupRequest"
"/api/v1/admin/providersetups/{providersetupId}":
get:
summary: Get an in-progress provider setup
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ProviderSetupResponse"
operationId: admin-get-providersetup
description: Get the setup instructions for an Access Provider.
parameters:
- schema:
type: string
name: providersetupId
in: path
required: true
delete:
summary: Delete an in-progress provider setup
operationId: admin-delete-providersetup
tags:
- Admin
responses:
"200":
$ref: "#/components/responses/ProviderSetupResponse"
description: |-
Removes an in-progress provider setup and deletes all data relating to it.
Returns the deleted provider.
"/api/v1/admin/providersetups/{providersetupId}/instructions":
get:
summary: Get the setup instructions for an Access Provider
tags:
- Admin
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ProviderSetupInstructions"
operationId: admin-get-providersetup-instructions
description: Get the setup instructions for an Access Provider.
parameters:
- schema:
type: string
name: providersetupId
in: path
required: true
"/api/v1/admin/providersetups/{providersetupId}/validate":
parameters:
- schema:
type: string
name: providersetupId
in: path
required: true
post:
summary: Validate the configuration for a Provider Setup
operationId: admin-validate-providersetup
responses:
"200":
$ref: "#/components/responses/ProviderSetupResponse"
tags:
- Admin
description: |-
Validates the configuration values for an access provider being setup.
Will return a HTTP200 OK response even if there are validation errors. The errors can be found by inspecting the validation diagnostics in the `configValidation` field.
Will return a HTTP400 response if the provider cannot be validated (for example, the config values for the provider are incomplete).
"/api/v1/admin/providersetups/{providersetupId}/complete":
parameters:
- schema:
type: string
name: providersetupId
in: path
required: true
post:
summary: Complete a ProviderSetup
operationId: admin-complete-providersetup
tags:
- Admin
description: "If Runtime Configuration is enabled, this will write the Access Provider to the configuration storage and activate it. If Runtime Configuration is disabled, this endpoint does nothing."
responses:
"200":
$ref: "#/components/responses/CompleteProviderSetupResponse"
"/api/v1/admin/providersetups/{providersetupId}/steps/{stepIndex}/complete":
parameters:
- schema:
type: integer
name: stepIndex
in: path
required: true
description: The step index to update the completion status for.
- schema:
type: string
name: providersetupId
in: path
required: true
put:
summary: Update the completion status for a Provider setup step
operationId: admin-submit-providersetup-step
responses:
"200":
$ref: "#/components/responses/ProviderSetupResponse"
description: The updated provider setup.
requestBody:
$ref: "#/components/requestBodies/ProviderSetupStepCompleteRequest"
tags:
- Admin
/api/v1/admin/identity/sync:
parameters: []
post:
summary: Sync Identity
operationId: admin-sync-identity
responses:
"200":
description: OK