-
Notifications
You must be signed in to change notification settings - Fork 2
/
permissions.raml
454 lines (449 loc) · 12.8 KB
/
permissions.raml
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
#%RAML 1.0
title: Permissions
version: v5.5
baseUri: http://github.com/org/folio/mod-auth/permissions
documentation:
- title: mod-permissions API
content: This module is responsible for managing and retrieving permissions in the FOLIO system
types:
permission: !include permission.json
permissionNameObject: !include permissionNameObject.json
permissionListObject: !include permissionListObject.json
permissionUser: !include permissionUser.json
permissionUserListObject: !include permissionUserListObject.json
permissionNameListObject: !include permissionNameListObject.json
permissionUpload: !include permissionUpload.json
errors: !include raml-util/schemas/errors.schema
traits:
validate: !include raml-util/traits/validation.raml
pageable: !include raml-util/traits/pageable.raml
pageable_legacy:
queryParameters:
length:
description: "The maximum number of results to return. Deprecated: use limit"
required: false
type: integer
example: 10
minimum: 1
default: 10
maximum: 2147483647
start:
description: "The starting index in a list of results starting from 1. Deprecated: use offset"
required: false
type: integer
minimum: 1
default: 1
maximum: 2147483647
sortable:
queryParameters:
sortBy:
description: "A comma-separated list of fieldnames to sort by"
required: false
type: string
queryable:
queryParameters:
query:
description: "A query string to filter users based on matching criteria in fields."
required: false
type: string
byMember:
queryParameters:
memberOf:
description: "A list of permission names that any returned permission must be a sub-permission of."
required: false
type: string
byOwner:
queryParameters:
ownedBy:
description: "A list of user names that any returned permissions must belong to."
required: false
type: string
indexSelectable:
queryParameters:
indexField:
description: "Specify a field other than 'id' to look up the permission user by"
required: false
type: string
example: "userId"
/perms:
/users:
get:
description: Get a list of users
is: [
pageable,
pageable_legacy,
sortable,
queryable
]
responses:
200:
body:
application/json:
type: permissionUserListObject
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
post:
description: Add a new user
is: [validate]
body:
application/json:
type: permissionUser
responses:
201:
body:
application/json:
type: permissionUser
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/{id}:
get:
description: Get a permission user
is: [ indexSelectable ]
responses:
200:
body:
application/json:
type: permissionUser
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
404:
description: "User not found"
body:
text/plain:
example: "User does not exist"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
put:
description: Modify an existing user
is: [validate]
body:
application/json:
type: permissionUser
responses:
200:
body:
application/json:
type: permissionUser
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
404:
description: "User not found"
body:
text/plain:
example: "User not found"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
delete:
description: Remove a user
is: [ indexSelectable ]
responses:
204:
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
404:
description: "User not found"
body:
text/plain:
example: "User not found"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/permissions:
get:
description: Get permissions that a user has
queryParameters:
expanded:
description: Recursively return all subpermissions
required: false
type: string
example: "true"
full:
description: Return full permission objects, as opposed to just permission names
required: false
type: string
example: "true"
is: [
indexSelectable
]
responses:
200:
description: "An object of returned permissions"
body:
application/json:
type: permissionNameListObject
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
404:
description: "User not found"
body:
text/plain:
example: "User not found"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
post:
description: Add a permission to a user
is: [validate, indexSelectable]
body:
application/json:
type: permissionNameObject
responses:
200:
description: "The added permission"
body:
application/json:
type: permissionNameObject
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/{permissionname}:
delete:
description: Remove a permission from a user
is: [ indexSelectable ]
responses:
204:
400:
description: "Bad request"
body:
text/plain:
404:
description: "Permission not found in user"
body:
text/plain:
example: "Permission not found in user"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/permissions:
get:
description: Get a list of existing permissions
queryParameters:
expandSubs:
description: Return one level of subpermissions as objects if true. If false or omitted, expanded will be considered.
required: false
type: string
example: "true"
expanded:
description: Recursively return all subpermissions as strings if true. Is only considered if expandSubs is false or omitted.
required: false
type: string
example: "true"
includeDummy:
description: "Return placeholder 'dummy' permissions"
required: false
type: string
example: "true"
is: [
pageable,
pageable_legacy,
sortable,
queryable,
byMember,
byOwner
]
responses:
200:
body:
application/json:
type: permissionListObject
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
post:
description: Add a new permission
is: [validate]
body:
application/json:
type: permissionUpload
responses:
201:
body:
application/json:
type:
permissionUpload
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/{id}:
get:
description: Get an existing permission by id
responses:
200:
body:
application/json:
type: permission
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
404:
description: "Permission not found"
body:
text/plain:
example: "Permission not found"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
put:
description: Modify an existing permission
is: [validate]
body:
application/json:
type: permissionUpload
responses:
200:
body:
application/json:
type: permissionUpload
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
403:
description: "Access Denied"
body:
text/plain:
example: "Access Denied"
404:
description: "Permission not found"
body:
text/plain:
example: "Permission not found"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
delete:
description: Remove a permission
responses:
204:
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
404:
description: "Permission not found"
body:
text/plain:
example: "Permission not found"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/purge-deprecated:
post:
description: purge deprecated permissions
responses:
200:
description: "A list of permission names purged"
body:
application/json:
type: permissionNameListObject
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"