-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathswagger.yml
1115 lines (1115 loc) · 34.6 KB
/
swagger.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
consumes:
- application/json
definitions:
error_out:
type: object
description: "The standard format for an error response body."
required:
- reason
properties:
reason:
type: string
description: "The reason for the error."
minLength: 1
service_info:
type: object
required:
- description
- service
- version
properties:
description:
type: string
description: "A brief description of the service."
minLength: 1
service:
type: string
description: "The name of the service."
minLength: 1
version:
type: string
description: "The service's version number."
minLength: 1
resource_type_in:
type: object
description: "An incoming resource type."
required:
- name
properties:
name:
type: string
description: "The name of the resource type."
minLength: 1
description:
type: string
description: "A brief description of the resource type."
resource_type_out:
type: object
description: "An outgoing resource type."
required:
- id
- name
properties:
id:
type: string
description: "The resource type identifier."
minLength: 36
maxLength: 36
name:
type: string
description: "The name of the resource type."
minLength: 1
description:
type: string
description: "A brief description of the resource type."
resource_types_out:
type: object
description: "A list of resource types."
required:
- resource_types
properties:
resource_types:
type: array
description: "The list of resource types."
items:
$ref: "#/definitions/resource_type_out"
resource_in:
type: object
description: "An incoming resource."
required:
- name
- resource_type
properties:
name:
type: string
description: "The resource name."
minLength: 1
resource_type:
type: string
description: "The resource type name."
minLength: 1
resource_update:
type: object
description: "A modification to a resource."
required:
- name
properties:
name:
type: string
description: "The new resource name."
minLength: 1
resource_out:
type: object
description: "An outgoing resource."
required:
- id
- name
- resource_type
properties:
id:
type: string
description: "The resource identifier."
minLength: 36
maxLength: 36
name:
type: string
description: "The resource name."
minLength: 1
resource_type:
type: string
description: "The resource type name."
minLength: 1
resources_out:
type: object
description: "A list of resources."
required:
- resources
properties:
resources:
type: array
description: "The list of resources."
items:
$ref: "#/definitions/resource_out"
internal_subject_id:
type: string
description: "The internal subject identifier."
minLength: 36
maxLength: 36
external_subject_id:
type: string
description: "The external subject identifier."
minLength: 1
maxLength: 64
subject_type:
type: string
description: "The subject type."
enum:
- user
- group
subject_source_id:
type: string
description: "The subject source ID."
minLength: 1
maxLength: 255
subject_in:
type: object
description: "An incoming subject."
required:
- subject_id
- subject_type
properties:
subject_id:
$ref: "#/definitions/external_subject_id"
subject_type:
$ref: "#/definitions/subject_type"
subjects_in:
type: object
description: "An incoming list of subjects."
required:
- subjects
properties:
subjects:
type: array
description: "The list of subjects."
items:
$ref: "#/definitions/subject_in"
subject_out:
type: object
description: "An outgoing subject."
required:
- id
- subject_id
- subject_type
- subject_source_id
properties:
id:
$ref: "#/definitions/internal_subject_id"
subject_id:
$ref: "#/definitions/external_subject_id"
subject_type:
$ref: "#/definitions/subject_type"
subject_source_id:
$ref: "#/definitions/subject_source_id"
subjects_out:
type: object
description: "A list of subjects."
required:
- subjects
properties:
subjects:
type: array
description: "The list of subjects."
items:
$ref: "#/definitions/subject_out"
permission_id:
type: string
description: "The internal permission identifier."
minLength: 36
maxLength: 36
permission_level:
type: string
description: "A permission level name."
enum:
- read
- admin
- write
- own
permission_grant_request:
type: object
description: "Information for granting permission to a user."
required:
- subject
- resource
- permission_level
properties:
subject:
$ref: "#/definitions/subject_in"
resource:
$ref: "#/definitions/resource_in"
permission_level:
$ref: "#/definitions/permission_level"
permission_put_request:
type: object
description: "Specifies the permission level to assign."
required:
- permission_level
properties:
permission_level:
$ref: "#/definitions/permission_level"
permission:
type: object
description: "Information about permissions granted to a user."
required:
- id
- subject
- resource
- permission_level
properties:
id:
$ref: "#/definitions/permission_id"
subject:
$ref: "#/definitions/subject_out"
resource:
$ref: "#/definitions/resource_out"
permission_level:
$ref: "#/definitions/permission_level"
permission_list:
type: object
description: "A list of matching permissions."
required:
- permissions
properties:
permissions:
type: array
description: "The list of permissions."
items:
$ref: "#/definitions/permission"
abbreviated_permission:
type: object
description: "Abbrevated information about permissions granted to a user."
required:
- id
- resource_name
- resource_type
- permission_level
properties:
id:
$ref: "#/definitions/permission_id"
resource_name:
type: string
description: "The resource name."
minLength: 1
resource_type:
type: string
description: "The resource type name."
minLength: 1
permission_level:
$ref: "#/definitions/permission_level"
abbreviated_permission_list:
type: object
description: "A list of matching permissions."
required:
- permissions
properties:
permissions:
type: array
description: "The list of permissions."
items:
$ref: "#/definitions/abbreviated_permission"
info:
description: >-
Manages Permissions for the CyVerse Discovery Environment and related applications.
title: "Permissions Service"
version: "5.2.8.0"
paths:
/:
get:
tags:
- status
summary: "Service Status Information"
description: >-
Displays general information about the service and can be used to determine whether or not the service is
running.
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/service_info"
/resource_types:
get:
tags:
- resource_types
summary: "List Resource Types"
description: >-
Lists resource types known to the permissions service. A resource type represents a class of resources to
which permissions may be applied. For example, the Discovery environment has apps collectively defined as
a single resource type in the permissions service.
parameters:
- name: "resource_type_name"
type: "string"
in: query
description: "The resource type name to search for."
responses:
200:
description: "Success"
schema:
$ref: "#/definitions/resource_types_out"
500:
$ref: "#/responses/internal_server_error"
delete:
tags:
- resource_types
summary: "Delete a Resource Type by Name"
description: "Deletes the resource type with the given name."
operationId: deleteResourceTypeByName
parameters:
- name: "resource_type_name"
type: "string"
in: query
description: "The resource type name to search for."
required: True
responses:
200:
description: "Deleted"
400:
$ref: "#/responses/bad_request"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
post:
tags:
- resource_types
summary: "Add a Resource Type"
description: >-
Adds a resource type to the list of available resource types. The name of the resource type must be unique.
parameters:
- description: "The resource type to add."
in: body
name: "resource_type_in"
required: True
schema:
$ref: "#/definitions/resource_type_in"
responses:
201:
description: "Created"
schema:
$ref: "#/definitions/resource_type_out"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/resource_types/{id}:
parameters:
- name: id
type: string
description: "The resource type ID."
in: path
required: True
put:
tags:
- resource_types
summary: "Update a Resource Type"
description: >-
Updates the name or description of a resource type. The new name of the resource type must be unique if one
is provided.
parameters:
- description: "The new name and description of the resource type."
in: body
name: "resource_type_in"
required: True
schema:
$ref: "#/definitions/resource_type_in"
responses:
200:
description: "Updated"
schema:
$ref: "#/definitions/resource_type_out"
400:
$ref: "#/responses/bad_request"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
delete:
tags:
- resource_types
summary: "Delete a Resource Type"
description: >-
Removes a resource type from the database. A resource type may only be removed if there are no resources
associated with it.
responses:
200:
description: "Deleted"
400:
$ref: "#/responses/bad_request"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
/resources:
delete:
tags:
- resources
summary: "Delete Resources by Name"
description: >-
Removes a resource from the database. A resource is a single item to which permissions may be applied. For
example. The Discovery Environment app, Word Count, would be defined as a resource in the permissions
service.
operationId: deleteResourceByName
parameters:
- name: "resource_type_name"
type: "string"
in: query
description: "The resource type name to search for."
required: True
- name: "resource_name"
type: "string"
in: query
description: "The resource name to search for."
required: True
responses:
200:
description: "OK"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
get:
tags:
- resources
summary: "List Resources"
description: >-
Lists resources in the database. A resource is a single item to which permissions may be applied. For example
The Discovery Environment app, Word Count, would be defined as a resource in the permissions service.
operationId: listResources
parameters:
- name: "resource_type_name"
type: "string"
in: query
description: "The resource type name to search for."
- name: "resource_name"
type: "string"
in: query
description: "The resource name to search for."
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/resources_out"
500:
$ref: "#/responses/internal_server_error"
post:
tags:
- resources
summary: "Add a Resource"
description: >-
Adds a resource to the database. A resource is a single item to which permissions may be applied. For example
The Discovery Environment app, Word Count, would be defined as a resource in the permissions service.
parameters:
- description: "The new resource to add."
in: body
name: "resource_in"
required: True
schema:
$ref: "#/definitions/resource_in"
operationId: addResource
responses:
201:
description: "Created"
schema:
$ref: "#/definitions/resource_out"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/resources/{id}:
parameters:
- name: id
type: string
description: "The resource ID."
in: path
required: True
put:
tags:
- resources
summary: "Update a Resource"
description: "Updates a resource in the database."
parameters:
- description: "The updated resource information."
in: body
name: "resource_update"
required: True
schema:
$ref: "#/definitions/resource_update"
operationId: updateResource
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/resource_out"
400:
$ref: "#/responses/bad_request"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
delete:
tags:
- resources
summary: "Delete a Resource"
description: "Removes a resource from the database."
operationId: deleteResource
responses:
200:
description: "OK"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
/subjects:
delete:
tags:
- subjects
summary: "Delete Subjects by External ID"
description: >-
Removes subjects (entities to which permissions may be gratned) from the database.
operationId: deleteSubjectByExternalId
parameters:
- name: "subject_id"
type: "string"
in: query
description: "The external subject identifier."
required: True
- name: "subject_type"
type: "string"
enum:
- "user"
- "group"
in: query
description: "The subject type."
required: True
responses:
200:
description: "OK"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
get:
tags:
- subjects
summary: "List Subjects"
description: >-
Lists subjects (entities to which permissions may be gratned) that exist in the database.
operationId: listSubjects
parameters:
- name: "subject_id"
type: "string"
in: query
description: "The external subject identifier."
- name: "subject_type"
type: "string"
enum:
- "user"
- "group"
in: query
description: "The subject type."
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/subjects_out"
500:
$ref: "#/responses/internal_server_error"
post:
tags:
- subjects
summary: "Add a Subject"
description: >-
Adds a subject (an entity to which permissions may be granted) to the database. For full use of the
permissions service, the subject should be present in Grouper and have the same subject ID in Grouper
and the permissions service.
parameters:
- description: "The new subject to add."
in: body
name: "subject_in"
required: True
schema:
$ref: "#/definitions/subject_in"
operationId: addSubject
responses:
201:
description: "Created"
schema:
$ref: "#/definitions/subject_out"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/subjects/{id}:
parameters:
- name: id
type: string
description: "The subject ID."
in: path
required: True
put:
tags:
- subjects
summary: "Update a Subject"
description: >-
Updates a subject in the database. For full use of the permissions service, the subject should be present
in Grouper and have the same subject ID in Grouper and the permissions service.
parameters:
- description: "The new subject information."
in: body
name: "subject_in"
required: True
schema:
$ref: "#/definitions/subject_in"
operationId: updateSubject
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/subject_out"
400:
$ref: "#/responses/bad_request"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
delete:
tags:
- subjects
summary: "Delete a Subject"
description: "Deletes a subject from the database."
operationId: deleteSubject
responses:
200:
description: "OK"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
/permissions:
get:
tags:
- permissions
summary: "List Permissions"
description: >-
Lists all permissions in the permission database. The total number of permissions for all resources is likely
to be quite large, so callers should be prepared to handle the response body. If this endpoint is used more
frequently than anticipated, limit and offset parameters will be added for paging later.
operationId: listPermissions
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/permission_list"
500:
$ref: "#/responses/internal_server_error"
post:
tags:
- permissions
summary: "Grant Permission to a Resource"
description: >-
Grants permission to access a resource to a subject. If the subject already has permission to access the
resource then the permission level will be updated (assuming the new permission level is different from
the existing permission level). Neither the resource nor the subject needs to be registered in the database
before this endpoint is called; they will be added to the database if necessary. This endpoint will return
an error response if the subject ID is already in use and associated with a different subject type. It will
also return an error if either the specified resource type or permission level does not exist.
parameters:
- description: "Information about the permission to add."
in: body
name: "permission_grant_request"
required: True
schema:
$ref: "#/definitions/permission_grant_request"
operationId: grantPermission
responses:
200:
description: "Created"
schema:
$ref: "#/definitions/permission"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/permissions/resources/{resource_type}/{resource_name}:
parameters:
- name: resource_type
type: string
description: "The resource type name."
in: path
required: True
- name: resource_name
type: string
description: "The resource name."
in: path
required: True
get:
tags:
- permissions
summary: "List Resource Permissions"
description: "Lists all of the permissions associated with a resource."
operationId: listResourcePermissions
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/permission_list"
500:
$ref: "#/responses/internal_server_error"
/permissions/resources/{resource_type}/{resource_name}/subjects/{subject_type}/{subject_id}:
parameters:
- name: resource_type
type: string
description: "The resource type name."
in: path
required: True
- name: resource_name
type: string
description: "The resource name."
in: path
required: True
- name: subject_type
type: string
enum:
- user
- group
description: "The subject type name."
in: path
required: True
- name: subject_id
type: string
description: "The external subject identifier."
in: path
required: True
delete:
tags:
- permissions
summary: "Revoke Permission to a Resource"
description: >-
Removes a permission entry from the database. This endpoint will return an error status if the resource type,
resource, subject or the permission itself does not exist.
operationId: revokePermission
responses:
200:
description: "OK"
404:
$ref: "#/responses/not_found"
500:
$ref: "#/responses/internal_server_error"
put:
tags:
- permissions
summary: "Grant Permission to a Resource"
description: >-
Grants permission to access a resource to a subject. If the subject already has permission to access the
resource then the permission level will be updated (assuming the new permission level is different from
the existing permission level). Neither the resource nor the subject needs to be registered in the database
before this endpoint is called; they will be added to the database if necessary. This endpoint will return
an error response if the subject ID is already in use and associated with a different subject type. It will
also return an error if either the specified resource type or permission level does not exist.
parameters:
- description: "The permission level to assign."
in: body
name: "permission"
required: True
schema:
$ref: "#/definitions/permission_put_request"
operationId: putPermission
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/permission"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/permissions/subjects/{subject_type}/{subject_id}:
parameters:
- name: subject_type
type: string
enum:
- user
- group
description: "The subject type name."
in: path
required: True
- name: subject_id
type: string
description: "The external subject identifier."
in: path
required: True
- name: lookup
type: boolean
description: >-
True if a permission lookup should be performed. A permission lookup differs from standard permisison
retrieval in two ways. First, only the most permissive permission level available to the subject is
returned for any given resource. Second, if the subject happens to be a user then permissions granted
to groups that the user belongs to are also included in the results. This parameter is optional and
defaults to False.
in: query
default: False
- name: min_level
type: string
enum:
- read
- admin
- write
- own
description: >-
The minimum permission level required to qualify for the result set. All permission levels qualify by
default.
in: query
get:
tags:
- permissions
summary: "Look Up by Subject"
description: >-
Looks up all permissions granted to a subject. If lookup mode is enabled and the subject is a user, the most
lenient permissions granted to the subject or any groups the subject belongs to will be listed. If lookup mode
is not enabled or the subject is a group then only permissions assigned directly to the subject will be listed.
This endpoint will return an error status if the subject ID is in use and associated with a different subject
type.
operationId: bySubject
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/permission_list"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/permissions/subjects/{subject_type}/{subject_id}/copy:
parameters:
- name: subject_type
type: string
enum:
- user
- group
description: "The subject type name."
in: path
required: True
- name: subject_id
type: string
description: "The external subject identifier."
in: path
required: True
post:
tags:
- permissions
summary: "Copy Permissions Between Subjects"
description: >-
Copies all permissions that have been granted to one subject to one or more other subjects. Only permissions
that are assigned directly to the source subject are copied. Permissions that are granted to groups that the
source subject belongs to are not copied.
parameters:
- description: "The destination subjects."
in: body
name: "destSubjects"
required: True
schema:
$ref: "#/definitions/subjects_in"
operationId: copyPermissions
responses:
200:
description: "OK"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/permissions/subjects/{subject_type}/{subject_id}/{resource_type}:
parameters:
- name: subject_type
type: string
enum:
- user
- group
description: "The subject type name."
in: path
required: True
- name: subject_id
type: string
description: "The external subject identifier."
in: path
required: True
- name: resource_type
type: string
description: "The resource type name."
in: path
required: True
- name: lookup
type: boolean
description: >-
True if a permission lookup should be performed. A permission lookup differs from standard permisison
retrieval in two ways. First, only the most permissive permission level available to the subject is
returned for any given resource. Second, if the subject happens to be a user then permissions granted
to groups that the user belongs to are also included in the results. This parameter is optional and
defaults to False.
in: query
default: False
- name: min_level
type: string
enum:
- read
- admin
- write
- own
description: >-
The minimum permission level required to qualify for the result set. All permission levels qualify by
default.
in: query
get:
tags:
- permissions
summary: "Look Up by Subject and Resource Type"
description: >-
Looks up all permissions granted to a subject for resources of the given type. If lookup mode is enabled and
the subject is a user, the most lenient permissions granted to the subject or any groups the subject belongs
to will be listed. If lookup mode is not enabled or the subject is a group then only permissions assigned
directly to the subject will be listed. This endpoint will return an error status if the subject ID is in use
and associated with a different subject type.
operationId: bySubjectAndResourceType
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/permission_list"
400:
$ref: "#/responses/bad_request"
500:
$ref: "#/responses/internal_server_error"
/permissions/subjects/{subject_type}/{subject_id}/{resource_type}/{resource_name}:
parameters:
- name: subject_type
type: string
enum:
- user
- group
description: "The subject type name."
in: path
required: True
- name: subject_id
type: string
description: "The external subject identifier."
in: path
required: True
- name: resource_type
type: string
description: "The resource type name."
in: path
required: True
- name: resource_name
type: string
description: "The resource name."
in: path
required: True
- name: lookup
type: boolean
description: >-
True if a permission lookup should be performed. A permission lookup differs from standard permisison
retrieval in two ways. First, only the most permissive permission level available to the subject is
returned for any given resource. Second, if the subject happens to be a user then permissions granted
to groups that the user belongs to are also included in the results. This parameter is optional and