-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
11202 lines (11150 loc) · 370 KB
/
openapi.yaml
File metadata and controls
11202 lines (11150 loc) · 370 KB
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.1.0
info:
contact:
email: hello@opal.dev
name: Opal Team
url: https://www.opal.dev/
description: The Opal API is a RESTful API that allows you to interact with the Opal Security platform programmatically.
title: Opal API
version: "1.0"
servers:
- description: Production
url: https://api.opal.dev/v1
# keep tags alphabetized, also add any new tags to the list below
tags:
- name: access-rules
description: Operations related to access rules
- name: apps
description: Operations related to apps
- name: bundles
description: Operations related to bundles
- name: configuration-templates
description: Operations related to configuration templates
- name: delegations
description: Operations related to request reviewer delegations
- name: events
description: Operations related to events
- name: groups
description: Operations related to groups
- name: group-bindings
description: Operations related to group bindings
- name: idp-group-mappings
description: Operations related to IDP group mappings
- name: message-channels
description: Operations related to message channels
- name: non-human-identities
description: Operations related to non-human identities
- name: on-call-schedules
description: Operations related to on-call schedules
- name: owners
description: Operations related to owners
- name: requests
description: Operations related to requests
- name: resources
description: Operations related to resources
- name: sessions
description: Operations related to sessions
- name: tags
description: Operations related to tags
- name: uars
description: Operations related to UARs
- name: users
description: Operations related to users
paths:
/apps:
get:
summary: Get apps
description: Returns a list of `App` objects.
operationId: getApps
parameters:
- description: A list of app types to filter by.
example:
- OKTA_DIRECTORY
- GIT_HUB
explode: false
in: query
name: app_type_filter
required: false
schema:
items:
$ref: "#/components/schemas/AppTypeEnum"
type: array
style: form
- description: An owner ID to filter by.
example: 29827fb8-f2dd-4e80-9576-28e31e9934ac
explode: true
in: query
name: owner_filter
required: false
schema:
format: uuid
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AppsList"
description: A list of apps for your organization.
security:
- BearerAuth: []
tags:
- apps
/apps/{app_id}:
get:
summary: Get app by ID
description: Returns an `App` object.
operationId: getApp
parameters:
- description: The ID of the app.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
explode: true
in: path
name: app_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/App"
description: The requested `App`.
security:
- BearerAuth: []
tags:
- apps
/bundles:
get:
summary: Get bundles
description: Returns a list of `Bundle` objects.
operationId: getBundles
parameters:
- description: The maximum number of bundles to return from the beginning of the list. Default is 200, max is 1000.
example: 200
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: A cursor indicating where to start fetching items after a specific point.
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
explode: true
in: query
name: cursor
required: false
schema:
type: string
style: form
- description: A filter for the bundle name.
example: Engineering
explode: true
in: query
name: contains
required: false
schema:
type: string
style: form
responses:
"200":
description: A list of bundles for your organization.
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedBundleList"
security:
- BearerAuth: []
tags:
- bundles
post:
description: Creates a bundle.
operationId: createBundle
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateBundleInfo"
responses:
"201":
description: The bundle successfully created.
content:
application/json:
schema:
$ref: "#/components/schemas/Bundle"
security:
- BearerAuth: []
tags:
- bundles
/bundles/{bundle_id}:
get:
summary: Get bundle by ID
description: Returns a `Bundle` object.
operationId: getBundle
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
explode: true
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Bundle"
description: The requested `Bundle`.
security:
- BearerAuth: []
tags:
- bundles
delete:
description: Deletes a bundle.
operationId: deleteBundle
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
explode: true
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
description: The bundle was successfully deleted.
security:
- BearerAuth: []
tags:
- bundles
put:
description: Updates a bundle.
operationId: updateBundle
parameters:
- description: The ID of the bundle to be updated.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Bundle"
responses:
"200":
description: The bundle was successfully updated.
content:
application/json:
schema:
$ref: "#/components/schemas/Bundle"
"204":
description: No changes detected (no-op)
security:
- BearerAuth: []
tags:
- bundles
/bundles/{bundle_id}/resources:
get:
description: Returns a list of `Resource` objects in a given bundle.
operationId: getBundleResources
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
style: simple
- description: The maximum number of resources to return from the beginning of the list. Default is 200, max is 1000.
example: 200
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: A cursor indicating where to start fetching items after a specific point.
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
explode: true
in: query
name: cursor
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedBundleResourceList"
description: A list of resources for the bundle.
security:
- BearerAuth: []
tags:
- bundles
post:
description: Adds a resource to a bundle.
operationId: addBundleResource
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
requestBody:
required: false
content:
application/json:
schema:
properties:
resource_id:
description: The ID of the resource to add.
example: 72e75a6f-7183-48c5-94ff-6013f213314b
format: uuid
type: string
access_level_remote_id:
description: The remote ID of the access level to grant to this user. Required if the resource being added requires an access level. If omitted, the default access level remote ID value (empty string) is used.
example: arn:aws:iam::590304332660:role/AdministratorAccess
type: string
access_level_name:
description: The name of the access level to grant to this user. If omitted, the default access level name value (empty string) is used.
example: AdministratorAccess
type: string
required:
- resource_id
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/BundleResource"
description: Resource was successfully added to the bundle.
security:
- BearerAuth: []
tags:
- bundles
/bundles/{bundle_id}/resources/{resource_id}:
delete:
description: Removes a resource from a bundle.
operationId: removeBundleResource
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
- description: The ID of the resource to remove.
example: 72e75a6f-7183-48c5-94ff-6013f213314b
in: path
name: resource_id
required: true
schema:
format: uuid
type: string
- description: The remote ID of the access level to grant. If omitted, the default access level remote ID value (empty string) is used.
example: arn:aws:iam::590304332660:role/AdministratorAccess
explode: true
in: query
name: access_level_remote_id
required: false
schema:
type: string
style: form
responses:
"200":
description: Resource was successfully removed from the bundle.
security:
- BearerAuth: []
tags:
- bundles
/bundles/{bundle_id}/groups:
get:
description: Returns a list of `Group` objects in a given bundle.
operationId: getBundleGroups
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
style: simple
- description: The maximum number of groups to return from the beginning of the list. Default is 200, max is 1000.
example: 200
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: A cursor indicating where to start fetching items after a specific point.
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
explode: true
in: query
name: cursor
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedBundleGroupList"
description: A list of groups for the bundle.
security:
- BearerAuth: []
tags:
- bundles
post:
description: Adds a group to a bundle.
operationId: addBundleGroup
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
requestBody:
required: true
content:
application/json:
schema:
properties:
group_id:
description: The ID of the group to add.
example: 72e75a6f-7183-48c5-94ff-6013f213314b
format: uuid
type: string
access_level_remote_id:
description: The remote ID of the access level to grant to this user. Required if the group being added requires an access level. If omitted, the default access level remote ID value (empty string) is used.
example: arn:aws:iam::590304332660:role/AdministratorAccess
type: string
access_level_name:
description: The name of the access level to grant to this user. If omitted, the default access level name value (empty string) is used.
example: AdministratorAccess
type: string
required:
- group_id
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/BundleGroup"
description: Group was successfully added to the bundle.
security:
- BearerAuth: []
tags:
- bundles
/bundles/{bundle_id}/groups/{group_id}:
delete:
description: Removes a group from a bundle.
operationId: removeBundleGroup
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
- description: The ID of the group to remove.
example: 72e75a6f-7183-48c5-94ff-6013f213314b
in: path
name: group_id
required: true
schema:
format: uuid
type: string
- description: The remote ID of the access level to remove.
example: arn:aws:iam::590304332660:role/AdministratorAccess
explode: true
in: query
name: access_level_remote_id
required: false
schema:
type: string
style: form
responses:
"200":
description: Group was successfully removed from the bundle.
security:
- BearerAuth: []
tags:
- bundles
/bundles/{bundle_id}/visibility:
get:
description: Gets the visibility of the bundle.
operationId: getBundleVisibility
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/VisibilityInfo"
description: The visibility details of a bundle.
security:
- BearerAuth: []
tags:
- bundles
put:
description: Sets the visibility of the bundle.
operationId: setBundleVisibility
parameters:
- description: The ID of the bundle.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
in: path
name: bundle_id
required: true
schema:
format: uuid
type: string
requestBody:
required: true
content:
application/json:
schema:
description: The visibility details of the bundle. Setting to LIMITED visibility with no visibility groups will make bundle only visible to admins and users with access.
$ref: "#/components/schemas/VisibilityInfo"
responses:
"200":
description: The visibility details of the bundle were successfully set.
security:
- BearerAuth: []
tags:
- bundles
/configuration-templates:
get:
description: Returns a list of `ConfigurationTemplate` objects.
operationId: getConfigurationTemplates
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedConfigurationTemplateList"
description: One page worth of configuration templates for your organization.
security:
- BearerAuth: []
tags:
- configuration-templates
post:
description: Creates a configuration template.
operationId: createConfigurationTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateConfigurationTemplateInfo"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigurationTemplate"
description: The configuration template just created.
security:
- BearerAuth: []
tags:
- configuration-templates
put:
description: Update a configuration template.
operationId: updateConfigurationTemplate
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigurationTemplate"
description: The configuration template just updated.
requestBody:
description: Configuration template to be updated
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateConfigurationTemplateInfo"
security:
- BearerAuth: []
tags:
- configuration-templates
/configuration-templates/{configuration_template_id}:
delete:
description: Deletes a configuration template.
operationId: deleteConfigurationTemplate
parameters:
- description: The ID of the configuration template.
example: 4baf8423-db0a-4037-a4cf-f79c60cb67a5
explode: false
in: path
name: configuration_template_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
description: The configuration template was successfully deleted.
security:
- BearerAuth: []
tags:
- configuration-templates
/events:
get:
description: Returns a list of `Event` objects.
operationId: events
parameters:
- description: A start date filter for the events.
examples:
withDate:
summary: Example with date
value: 2021-11-01
withDatetime:
summary: Example with date and time in ISO 8601 datetime format.
value: 2025-01-01T00:00:00Z
explode: true
in: query
name: start_date_filter
required: false
schema:
type: string
style: form
- description: An end date filter for the events.
examples:
withDate:
summary: Example with date
value: 2021-11-12
withDatetime:
summary: Example with date and time in ISO 8601 datetime format.
value: 2025-01-01T00:00:00Z
explode: true
in: query
name: end_date_filter
required: false
schema:
type: string
style: form
- description: An actor filter for the events. Supply the ID of the actor.
example: 29827fb8-f2dd-4e80-9576-28e31e9934ac
explode: true
in: query
name: actor_filter
required: false
schema:
format: uuid
type: string
style: form
- description: An object filter for the events. Supply the ID of the object.
example: 29827fb8-f2dd-4e80-9576-28e31e9934ac
explode: true
in: query
name: object_filter
required: false
schema:
format: uuid
type: string
style: form
- description: An event type filter for the events.
example: USER_MFA_RESET
explode: true
in: query
name: event_type_filter
required: false
schema:
type: string
style: form
- description: An API filter for the events. Supply the name and preview of the API token.
example: fullaccess:**************************M_g==
explode: true
in: query
name: api_token_filter
required: false
schema:
type: string
style: form
- description: The pagination cursor value.
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
explode: true
in: query
name: cursor
required: false
schema:
type: string
style: form
- description: Number of results to return per page. Default is 200.
example: 200
explode: true
in: query
name: page_size
required: false
schema:
type: integer
maximum: 1000
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedEventList"
description: One page worth of events with the appropriate filters applied.
security:
- BearerAuth: []
tags:
- events
/groups:
get:
summary: Get groups
description: Returns a list of groups for your organization.
operationId: getGroups
parameters:
- description: The pagination cursor value.
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
explode: true
in: query
name: cursor
required: false
schema:
type: string
style: form
- description: Number of results to return per page. Default is 200.
example: 200
explode: true
in: query
name: page_size
required: false
schema:
type: integer
maximum: 1000
style: form
- description: The group type to filter by.
example: OPAL_GROUP
explode: true
in: query
name: group_type_filter
required: false
schema:
$ref: "#/components/schemas/GroupTypeEnum"
style: form
- description: The group ids to filter by.
example:
- 4baf8423-db0a-4037-a4cf-f79c60cb67a5
- 1b978423-db0a-4037-a4cf-f79c60cb67b3
explode: false
in: query
name: group_ids
required: false
schema:
items:
example: 1b978423-db0a-4037-a4cf-f79c60cb67b3
format: uuid
type: string
type: array
style: form
- description: Group name.
example: example-name
explode: true
in: query
name: group_name
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PaginatedGroupsList"
description: One page worth groups associated with your organization.
security:
- BearerAuth: []
tags:
- groups
put:
description: Bulk updates a list of groups.
operationId: updateGroups
requestBody:
description: Groups to be updated
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateGroupInfoList"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateGroupInfoList"
description: The resulting updated group infos.
security:
- BearerAuth: []
tags:
- groups
post:
description: Creates an Opal group or [imports a remote group](https://docs.opal.dev/reference/end-system-objects).
operationId: createGroup
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateGroupInfo"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Group"
description: The group just created.
security:
- BearerAuth: []
tags:
- groups
/groups/{group_id}:
get:
summary: Get group by ID
description: Returns a `Group` object.
operationId: getGroup
parameters:
- description: The ID of the group.
example: 32acc112-21ff-4669-91c2-21e27683eaa1
explode: true
in: path
name: group_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Group"
description: The requested `Group`.
security:
- BearerAuth: []
tags:
- groups
delete:
description: Deletes a group.
operationId: delete_group
parameters:
- description: The ID of the group.
example: 4baf8423-db0a-4037-a4cf-f79c60cb67a5
explode: false
in: path
name: group_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
description: The group was successfully deleted.
security:
- BearerAuth: []
tags:
- groups
/groups/{group_id}/message-channels:
get:
description: Gets the list of audit and reviewer message channels attached to a group.
operationId: get_group_message_channels
parameters:
- description: The ID of the group.
example: 4baf8423-db0a-4037-a4cf-f79c60cb67a5
explode: false
in: path
name: group_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MessageChannelList"
description: The audit and reviewer message channels attached to the group.
security:
- BearerAuth: []
tags:
- groups
put:
description: Sets the list of audit message channels attached to a group.
operationId: set_group_message_channels
parameters:
- description: The ID of the group.
example: 4baf8423-db0a-4037-a4cf-f79c60cb67a5
explode: false
in: path
name: group_id
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/MessageChannelIDList"
responses:
"200":
content:
application/json:
schema:
items:
example: 1b978423-db0a-4037-a4cf-f79c60cb67b3
format: uuid
type: string
type: array
description: The updated audit message channel IDs for the group.
security:
- BearerAuth: []
tags:
- groups
/groups/{group_id}/on-call-schedules:
get:
description: Gets the list of on call schedules attached to a group.
operationId: get_group_on_call_schedules
parameters:
- description: The ID of the group.
example: 4baf8423-db0a-4037-a4cf-f79c60cb67a5
explode: false
in: path
name: group_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/OnCallScheduleList"
description: The on call schedules attached to the group.
security:
- BearerAuth: []
tags:
- groups
put:
description: Sets the list of on call schedules attached to a group.
operationId: set_group_on_call_schedules
parameters:
- description: The ID of the group.
example: 4baf8423-db0a-4037-a4cf-f79c60cb67a5
explode: false
in: path
name: group_id
required: true
schema: