This repository has been archived by the owner on Jul 6, 2021. It is now read-only.
forked from eu-sec/continuous-auditing-api-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bcloud_api.yaml
1824 lines (1814 loc) · 50 KB
/
bcloud_api.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.0
info:
description: |
Bayerncloud
version: 1.0.0
title: Bayerncloud Continuous Auditing API
termsOfService: https://bayerncloud.digital
contact:
url: https://bayerncloud.digital/kontakt/
tags:
- name: Scopes
description: Information about the scopes of a cloud system, e.g. a subscription or a resource group.
- name: Storage
description: Information about the storage entities in a scope.
- name: Identity and Access control
description: Information about the identity and access management of a cloud system.
- name: Container Services
description: Information about the container services in a certain scope.
- name: Networking
description: Information about the networking configuration in a certain scope.
- name: VM
description: Information about virtual machines in a certain scope.
- name: Logging
description: Information about the logging in a certain scope.
- name: Security Center
description: Information about the security recommendations.
- name: Functions
description: Information about serverless functions.
paths:
"/scopes":
get:
tags:
- Scopes
summary: Returns all scopes of the target system.
description: A scope can contain different kinds of resources and may, e.g. contain all components of a specific application. A scope can comprise, for instance, a subscription or a resource group.
operationId: listScopes
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListScopesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiScope
"/scopes/{scopeId}":
get:
tags:
- Scopes
summary: Returns information about a specific scopes of the target system.
description: A scope can contain different kinds of resources and may, e.g. contain all components of a specific application. A scope can comprise, for instance, a subscription or a resource group.
operationId: getScope
parameters:
- name: scopeId
in: path
description: ID of scope to return
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetScopeResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiScope
"/scopes/{scopeId}/storages":
get:
tags:
- Storage
summary: Returns a list of storage entities.
description: Returns a list of storage entities, e.g. storage accounts or S3 buckets.
operationId: listStorages
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListStoragesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}":
get:
tags:
- Storage
summary: Returns information about a specific storage entity.
operationId: getStorage
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage entity
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetStorageResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/objects":
get:
tags:
- Storage
summary: Returns a list of data objects in the specified storage entity.
operationId: getStorageObjects
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListObjectsResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/objects/{objectId}":
get:
tags:
- Storage
summary: Returns information about a specific data object.
operationId: getValidity
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage
required: true
schema:
type: string
- name: objectId
in: path
description: ID of the object
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetObjectResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/replications":
get:
tags:
- Storage
summary: Returns a list of replications of the specified storage entity.
description: description
operationId: getStorageReplications
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListStorageReplicationResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/replications/{replicationId}":
get:
tags:
- Storage
summary: Returns information about the specified storage replication.
operationId: getStorageReplication
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage
required: true
schema:
type: string
- name: replicationId
in: path
description: ID of the replication
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetStorageReplicationResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/objects/{objectId}/replications":
get:
tags:
- Storage
summary: Returns a list of replications of the specified object.
operationId: listObjectReplications
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage
required: true
schema:
type: string
- name: objectId
in: path
description: ID of the object
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListObjectReplicationResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/objects/{objectId}/replications/{replicationId}":
get:
tags:
- Storage
summary: Returns information about the specified object replication.
operationId: getObjectReplication
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: storageId
in: path
description: ID of the storage
required: true
schema:
type: string
- name: objectId
in: path
description: ID of the object
required: true
schema:
type: string
- name: replicationId
in: path
description: ID of the replication
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetObjectReplicationResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/geolocation":
get:
tags:
- Storage
summary: Returns information about the geolocation of the specified storage entity.
operationId: getStorageGeolocation
parameters:
- name: scopeId
in: path
description: Scope of service
required: true
schema:
type: string
- name: storageId
in: path
description: Scope of service
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetStorageGeolocationResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/scopes/{scopeId}/storages/{storageId}/objects/{objectId}/geolocation":
get:
tags:
- Storage
summary: Returns the geolocation of the specified object.
operationId: getObjectGeolocation
parameters:
- name: scopeId
in: path
description: Scope of service
required: true
schema:
type: string
- name: storageId
in: path
description: Scope of service
required: true
schema:
type: string
- name: objectId
in: path
description: ID of data object to return
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetObjectGeolocationResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiStorage
"/iam/users/":
get:
tags:
- Identity and Access Management
summary: Returns a list of all users.
description: Reads out all users of the IAM system and returns them.
operationId: listUsers
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListUsersResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/users/{userId}":
get:
tags:
- Identity and Access Management
summary: Returns information about a user.
operationId: getUser
parameters:
- name: userId
in: path
description: Scope of service
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetUserResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/groups/":
get:
tags:
- Identity and Access Management
summary: Returns a list of all groups.
description: Based on CCM-IAM-12. Reads out all administrators of the application and
returns them.
operationId: listGroups
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListGroupsResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/groups/{groupId}":
get:
tags:
- Identity and Access Management
summary: Returns information about a group.
operationId: getGroup
parameters:
- name: groupId
in: path
description: ID of the group
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetGroupResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/users/{userId}/groups":
get:
tags:
- Identity and Access Management
summary: Returns a list of all groups the specified user is assigned to.
operationId: getUserGroups
parameters:
- name: userId
in: path
description: ID of the user
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListUserGroupsResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/users/{userId}/roles":
get:
tags:
- Identity and Access Management
summary: Returns a list of all roles the specified user is assigned to.
operationId: getUserRoles
parameters:
- name: userId
in: path
description: ID of the user
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListUserRolesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/roles":
get:
tags:
- Identity and Access Management
summary: Returns a list of all roles that are specified in the cloud system.
operationId: listRoles
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListRolesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/data/access":
post:
tags:
- Identity and Access Management
summary: Checks whether a user has access to a certain resource.
description: Checks whether a user has access to a certain resource.
operationId: getResourceAccess
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AccessRequest"
description: request object
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/AccessResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/iam/passwordRequirements":
get:
tags:
- Identity and Access Management
summary: Returns the password requirements.
operationId: getPasswordRequirements
parameters:
- name: userId
in: path
description: ID of user
required: true
schema:
type: string
- name: scope
in: path
description: Scope of the service
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/PasswordRequirementsResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiIam
"/scopes/{scopeId}/containerservices":
get:
tags:
- Container Services
summary: Returns a list of container services, e.g. Kubernetes services.
operationId: listContainerServices
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListContainerServicesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiContainers
"/scopes/{scopeId}/containerservices/{serviceId}":
get:
tags:
- Container Services
summary: Returns information about the specified container service.
operationId: getContainerService
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
- name: serviceId
in: path
description: ID of the requested service
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetContainerServiceResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiContainers
"/scopes/{scopeId}/networking/vnets":
get:
tags:
- Networking
summary: Returns a list of virtual networks.
operationId: listVirtualNetworks
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListVnetsResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/vnets/{networkId}":
get:
tags:
- Networking
summary: Returns information about the specified virtual network.
operationId: getVirtualNetwork
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
- name: networkId
in: path
description: ID of the virtual network
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetVnetResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/securitygroups":
get:
tags:
- Networking
summary: Returns a list of network security groups.
operationId: listSecurityGroups
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListNetworkSecurityGroupsResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/securitygroups/{securitygroupId}":
get:
tags:
- Networking
summary: Returns information about the specified network security group.
operationId: getSecurityGroup
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: securitygroupId
in: path
description: Id of the network security group
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetNetworkSecurityGroupResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/securitygroups/{securitygroupId}/rules":
get:
tags:
- Networking
summary: Returns a list of network security group rules defined for the specified NSG.
operationId: listSecurityGroupRules
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
- name: securitygroupId
in: path
description: Id of the network security group
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListNetworkSecurityGroupRulesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/securitygroups/{securitygroupId}/rules/{ruleId}":
get:
tags:
- Networking
summary: Returns information about the specified network security group rule.
operationId: getSecuritygroupRule
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
- name: securitygroupId
in: path
description: ID of the network security group
required: true
schema:
type: string
- name: ruleId
in: path
description: ID of the network security group rule
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetNetworkSecurityGroupRuleResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/interfaces":
get:
tags:
- Networking
summary: Returns a lsit of network interfaces.
operationId: listNetworkInterfaces
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListNetworkInterfacesResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/networking/interfaces/{interfaceId}":
get:
tags:
- Networking
summary: Returns a lsit of network interfaces.
operationId: getNetworkInterface
parameters:
- name: scopeId
in: path
description: ID of the Scope
required: true
schema:
type: string
- name: interfaceId
in: path
description: ID of the interface
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/GetNetworkInterfaceResponse"
"405":
description: Invalid input
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiNetworking
"/scopes/{scopeId}/virtualmachines":
get:
tags:
- VM
summary: Returns a list of virtual machines.
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListVmsResponse"
security:
- api_key: []
- basic_auth: []
x-swagger-router-controller: CaApiVM
"/scopes/{scopeId}/virtualmachines/{virtualmachineId}":
get:
tags:
- VM
summary: Returns information about the specified virtual machine.
parameters:
- name: scopeId
in: path
description: ID of the scope
required: true
schema:
type: string
- name: virtualmachineId
in: path
description: ID of the VM
required: true
schema:
type: string
responses:
"200":