-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathfusillade-api.yml
1693 lines (1688 loc) · 52.6 KB
/
fusillade-api.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: Fusillade app demo
description: |
Human Cell Atlas Data Coordination Platform Fusillade app demo
Log in: [Auth0](/login?state=ABC&redirect_uri=https://$API_DOMAIN_NAME/internal/echo)
[OIDC spec](https://openid.net/specs/openid-connect-core-1_0.html#toc)
# Pagination
The Fusillade API supports pagination in a manner consistent with the
[GitHub API](https://developer.github.com/v3/guides/traversing-with-pagination/),
which is based on [RFC 5988](https://tools.ietf.org/html/rfc5988). When the
results of an API call exceed the page size specified, the HTTP response will
contain a `Link` header of the following form:
`Link: <https://auth.data.humancellatlas.org/v1/users?per_page=30&next_token=123>; rel="next"`.
The URL in the header refers to the next page of the results to be fetched;
if no `Link rel="next"` URL is included, then all results have been fetched.
The client should recognize and parse the `Link` header appropriately according
to RFC 5988, and retrieve the next page if requested by the user, or if all
results are being retrieved.
Additional Pagination Headers are returned to assist with client pagination these are:
`X-OpenAPI-Pagination` - boolean that indicates if there are more pages.
`X-OpenAPI-Paginated-Content-Key` - string that indicates which key in the response will be paged.
version: $FUS_VERSION
servers:
- url: https://$API_DOMAIN_NAME
paths:
/login:
get:
summary: Establish the users identity using the OIDC provider
description: Send the user agent to an identity provider selector and
generate a user account to establish the user's identity. This is a
redirect endpoint.
operationId: fusillade.api.oauth.login
tags:
- oauth
parameters:
- name: redirect_uri
description: Where to redirect to once login is complete.
in: query
required: true
schema:
type: string
- name: state
description: An opaque parameter that is returned back to the `redirect_uri`.
in: query
schema:
type: string
responses:
301:
description: OK.
default:
description: Unexpected error.
/logout:
get:
summary: Logout the user from current sessions with the OIDC provider.
description: Logout the user from current sessions with the OIDC provider. You can log the users out from a
specific application if the you know the client_id for the application. Otherwise the user will be logged out
of the default application by oauth2_config.
operationId: fusillade.api.oauth.logout
tags:
- oauth
parameters:
- name: client_id
in: query
schema:
type: string
responses:
200:
description: OK.
default:
description: Unexpected error.
/.well-known/openid-configuration:
get:
summary: See documentation at
[Provider Config](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig)
description: This endpoint is part of OIDC, see documentation at
[Provider Config](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig)
tags:
- oauth
parameters:
- in: header
name: host
schema:
type: string
default: $API_DOMAIN_NAME
required: true
description: Must be `$API_DOMAIN_NAME`.
operationId: fusillade.api.oauth.serve_openid_config
responses:
200:
description: Returns the supported openid endpoints.
/.well-known/jwks.json:
get:
summary: This endpoint is part of OIDC
description: Provide the public key used to sign all JWTs minted by the OIDC provider.
See [JSON Web Key Set](https://auth0.com/docs/jwks) for more info.
tags:
- oauth
operationId: fusillade.api.oauth.serve_jwks_json
responses:
200:
description: Returns the well known jwks.
/oauth/authorize:
get:
summary: See [Auth Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest)
description: This endpoint is part of OIDC and is used to redirect to an openid provider.
See [Auth Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest)
operationId: fusillade.api.oauth.authorize
tags:
- oauth
parameters:
- name: redirect_uri
in: query
schema:
type: string
- name: state
in: query
schema:
type: string
- name: client_id
in: query
schema:
type: string
- name: scope
in: query
schema:
type: string
- name: respone_type
in: query
schema:
type: string
- name: nonce
in: query
schema:
type: string
- name: prompt
in: query
schema:
type: string
responses:
302:
description: Redirecting to authentication server.
headers:
Location:
schema:
type: string
default:
description: Unexpected error.
/oauth/revoke:
post:
summary: Revoke a refresh token
description: Revokes a refresh token from a client making all future token refresh requests fail.
operationId: fusillade.api.oauth.revoke
tags:
- oauth
requestBody:
content:
application/json:
schema:
type: object
required:
- client_id
- token
properties:
client_id:
type: string
token:
type: string
description: The refresh token to revoke.
responses:
200:
description: OK.
default:
description: Unexpected error.
/oauth/token:
post:
summary: Retrieve the authentications token
description: This endpoint is part of OIDC and is used to redirect to an openid provider.
See [Token Endpoint](https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint), and
[Refresh Tokens](https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens)
operationId: fusillade.api.oauth.serve_oauth_token
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
redirect_uri:
description: Where to redirect to once login is complete.
type: string
code:
description: The code used to retrieve an access token from OIDC authentication flow.
type: string
grant_type:
description: The type of grant requested.
type: string
client_id:
type: string
client_secret:
type: string
refresh_token:
type: string
scope:
type: string
tags:
- oauth
responses:
302:
description: OK.
headers:
Cache-Control:
schema:
type: string
Pragma:
schema:
type: string
content:
application/json:
schema:
type: object
default:
description: Unexpected error.
/oauth/userinfo:
get:
summary: See [User Info](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
description: This endpoint is part of OIDC and is used to redirect to an openid provider.
See [User Info](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
operationId: fusillade.api.oauth.get_userinfo
security:
- BearerAuth: []
tags:
- oauth
responses:
200:
$ref: '#/components/responses/userinfo'
401:
$ref: '#/components/responses/401'
post:
summary: See [User Info](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
description: This endpoint is part of OIDC and is used to redirect to an openid provider.
See [User Info](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
operationId: fusillade.api.oauth.post_userinfo
security:
- BearerAuth: []
tags:
- oauth
responses:
200:
$ref: '#/components/responses/userinfo'
401:
$ref: '#/components/responses/401'
/echo:
get:
summary: echoes the response
description: Echoes the response back.
operationId: fusillade.api.internal.echo
responses:
200:
description: Echo.
/v1/policies/evaluate:
post:
summary: Evaluate a user's permissions
description: Given a set of principals, actions, and resources, return a
set of access control decisions.
operationId: fusillade.api.evaluate.evaluate_policy_api
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
required:
- principal
- action
- resource
type: object
properties:
principal:
description: Attested user identifier.
type: string
action:
description: The action the principal is attempting to perform.
type: array
items:
$ref: '#/components/schemas/policy_action'
resource:
description: The resource the principal will perform the action against.
type: array
maxItems: 1
minItems: 1
items:
$ref: '#/components/schemas/resource_name'
responses:
200:
description: The result of the policy evaluation.
content:
application/json:
schema:
type: object
properties:
result:
type: boolean
reason:
type: string
default:
description: Unexpected error.
/v1/users:
get:
summary: List users
description: Paginate through all users.
operationId: fusillade.api.users.get_users
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- user
/v1/user:
post:
summary: Create a new user
description: Create a new user with the specified groups, roles, and iam policy.
operationId: fusillade.api.users.post_user
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
required:
- user_id
type: object
properties:
user_id:
$ref: '#/components/schemas/custom_identifier'
groups:
type: array
items:
$ref: '#/components/schemas/custom_identifier'
roles:
type: array
items:
$ref: '#/components/schemas/custom_identifier'
policy:
$ref: '#/components/schemas/policy_document'
tags:
- user
responses:
201:
description: User was created.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
/v1/user/{user_id}:
get:
summary: Retrieve information about a user
description: Retrieve information about the user's status and the policies attached.
operationId: fusillade.api.users.get_user
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
tags:
- user
responses:
200:
description: Information about the user is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
put:
summary: Modify user status
description: Enable or disable a user. A disabled user will return false
for all evaluations with that user as principal.
operationId: fusillade.api.users.put_user
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
- $ref: '#/components/parameters/user_status'
tags:
- user
responses:
200:
description: Status set.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
/v1/user/{user_id}/owns:
get:
summary: Retrieve the resources owned by the user
description: Paginate through a list of resources owned by a user.
operationId: fusillade.api.users.get_users_owns
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/resource_type'
tags:
- user
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
/v1/user/{user_id}/groups:
get:
summary: Retrieve group(s) for a user
description: Paginate through a list of groups of which a user is a member.
operationId: fusillade.api.users.get_users_groups
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
tags:
- user
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
put:
summary: Add or remove a user from group(s)
description: Modify group(s) in which a user is a member.
operationId: fusillade.api.users.put_users_groups
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
- $ref: '#/components/parameters/action'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/groups'
tags:
- user
responses:
200:
description: Action successful.
401:
$ref: '#/components/responses/401'
304:
description: The user is already a member of this group.
default:
description: Unexpected error.
/v1/user/{user_id}/roles:
get:
summary: Retrieve roles a user is in
description: Paginate through all roles attached to a user.
operationId: fusillade.api.users.get_users_roles
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
tags:
- user
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
put:
summary: Add or remove user from role(s)
description: Modify the role(s) attached to a user.
operationId: fusillade.api.users.put_users_roles
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
- $ref: '#/components/parameters/action'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/roles'
tags:
- user
responses:
200:
description: Action successful.
401:
$ref: '#/components/responses/401'
304:
description: The user already has this role attached.
default:
description: Unexpected error.
/v1/user/{user_id}/policy:
put:
summary: Modify policy
description: Modify or add the user's IAM policy.
operationId: fusillade.api.users.put_user_policy
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/user_id'
requestBody:
content:
application/json:
schema:
type: object
properties:
policy:
$ref: '#/components/schemas/policy_document'
responses:
200:
description: Policy modified.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
tags:
- user
/v1/groups:
get:
summary: List groups
description: Paginate through all groups.
operationId: fusillade.api.groups.get_groups
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- group
/v1/group:
post:
summary: Create a new group
description: Create a new group, attach an IAM policy, and assign roles.
operationId: fusillade.api.groups.post_group
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
allOf:
- type: object
required:
- group_id
properties:
group_id:
$ref: '#/components/schemas/custom_identifier'
policy:
$ref: '#/components/schemas/policy_document'
- $ref: '#/components/schemas/roles'
responses:
201:
description: Group was successfully created.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
tags:
- group
/v1/group/{group_id}:
get:
summary: Get properties of a group
description: Get properties of a group, including the group's IAM policy.
operationId: fusillade.api.groups.get_group
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
responses:
200:
description: Information about the group was successfully returned.
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- group
delete:
summary: Remove a group from the system
description: Remove all users, policies, and roles from the group, and delete the group.
operationId: fusillade.api.groups.delete_group
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
responses:
200:
description: Group was successfully deleted.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
tags:
- group
/v1/group/{group_id}/roles:
get:
summary: Retrieve role(s) for a group
description: Paginate through all roles assigned to the group.
operationId: fusillade.api.groups.get_groups_roles
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
description: All roles have been successfully returned.
content:
application/json:
schema:
$ref: '#/components/schemas/roles'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- group
put:
summary: Add or remove a group from role(s)
description: Modify the role(s) assigned to a group.
operationId: fusillade.api.groups.put_groups_roles
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
- $ref: '#/components/parameters/action'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/roles'
responses:
200:
description: Action successful.
401:
$ref: '#/components/responses/401'
304:
description: The group already has this role attached.
default:
description: Unexpected error.
tags:
- group
/v1/group/{group_id}/users:
get:
summary: Retrieve user(s) in a group
description: Paginate through all users in a group.
operationId: fusillade.api.groups.get_group_users
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
description: All users have been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/users'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- group
put:
summary: Add or remove user(s) from a group
description: Modify the user(s) assigned to a group.
operationId: fusillade.api.groups.put_groups_users
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
- $ref: '#/components/parameters/action'
requestBody:
content:
application/json:
schema:
type: object
properties:
users:
type: array
minItems: 1
maxItems: 10
items:
$ref: '#/components/schemas/custom_identifier'
responses:
200:
description: Action successful.
401:
$ref: '#/components/responses/401'
304:
description: One or more users is already in this group.
default:
description: Unexpected error.
tags:
- group
/v1/group/{group_id}/policy:
put:
summary: Modify policy
description: Modify or create a policy attached to a group.
operationId: fusillade.api.groups.put_group_policy
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/group_id'
requestBody:
content:
application/json:
schema:
type: object
properties:
policy:
$ref: '#/components/schemas/policy_document'
responses:
200:
description: Policy modified.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
tags:
- group
/v1/roles:
get:
summary: List roles
description: Paginate through all roles.
operationId: fusillade.api.roles.get_roles
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- role
/v1/role:
post:
summary: Create a new role
description: Create a new role and attach a IAM policy.
operationId: fusillade.api.roles.post_role
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
required:
- role_id
- policy
properties:
role_id:
$ref: '#/components/schemas/custom_identifier'
policy:
$ref: '#/components/schemas/policy_document'
responses:
201:
description: Role was created.
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
409:
$ref: '#/components/responses/409'
default:
description: Unexpected error.
tags:
- role
/v1/role/{role_id}:
get:
summary: Get properties of a role
description: Get properties of a role.
operationId: fusillade.api.roles.get_role
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/role_id'
responses:
200:
description: Information about the role is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- role
delete:
summary: Remove a role from the system
description: Remove the role from all users and groups, and finally delete the role.
operationId: fusillade.api.roles.delete_role
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/role_id'
responses:
200:
description: Role was deleted.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
tags:
- role
/v1/role/{role_id}/policy:
put:
summary: Modify policy
description: Modify the IAM policy attached to the role.
operationId: fusillade.api.roles.put_role_policy
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/role_id'
requestBody:
content:
application/json:
schema:
type: object
properties:
policy:
$ref: '#/components/schemas/policy_document'
responses:
200:
description: Policy modified.
401:
$ref: '#/components/responses/401'
default:
description: Unexpected error.
tags:
- role
/v1/resources:
get:
summary: List available resource types
description: List available resource types
operationId: fusillade.api.resources.get
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
default:
description: Unexpected error.
tags:
- resource
/v1/resource/{resource_type_name}:
get:
summary: List all resources for this resource type
description: List all resources for this resource type
operationId: fusillade.api.resource.resource_type_name.get
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/resource_type_name'
- $ref: '#/components/parameters/next_token'
- $ref: '#/components/parameters/per_page'
responses:
200:
$ref: '#/components/responses/200_paged'
206:
$ref: '#/components/responses/206'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
default:
description: Unexpected error.
tags:
- resource
post:
summary: Create a new resource type.
description: Create a new resource type.
operationId: fusillade.api.resource.resource_type_name.post
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/resource_type_name'
requestBody:
content:
application/json:
schema:
allOf:
- type: object
properties:
owner_policy:
$ref: '#/components/schemas/policy_document'
- $ref: '#/components/schemas/policy_actions'
responses:
201:
description: The new resource type has been created.
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
409:
$ref: '#/components/responses/409'
default:
description: Unexpected error.
tags:
- resource
delete:
summary: Delete an existing resource type.
description: Delete an existing resource type if there are no ids of that resource type stored.
operationId: fusillade.api.resource.resource_type_name.delete
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/resource_type_name'
responses:
201:
description: The resource has been deleted.
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
409:
$ref: '#/components/responses/Resource_not_empty'
default:
description: Unexpected error.
tags:
- resource
/v1/resource/{resource_type_name}/actions:
get:
summary: List all actions for this resource type.