-
Notifications
You must be signed in to change notification settings - Fork 0
/
permission.yaml
649 lines (647 loc) · 18.9 KB
/
permission.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
openapi: 3.0.3
info:
title: Permissions API
version: 1.0.0
description: Flexible Role-based Access Control for epilot
tags:
- name: Roles
description: Manage roles and grants
- name: Assignments
description: Assign roles to users
security:
- EpilotAuth: []
- EpilotOrg: []
paths:
/v1/permissions/me:
get:
operationId: listCurrentRoles
summary: listCurrentRoles
description: Returns roles and grants assigned to current user
tags:
- Roles
responses:
'200':
description: ok
content:
application/json:
schema:
type: object
properties:
roles:
type: array
items:
$ref: '#/components/schemas/Role'
/v1/permissions/roles:
get:
operationId: listAllRoles
summary: listAllRoles
description: Returns list of all roles in organization
tags:
- Roles
responses:
'200':
description: ok
content:
application/json:
schema:
type: object
properties:
roles:
type: array
items:
$ref: '#/components/schemas/Role'
/v1/permissions/roles:search:
post:
operationId: searchRoles
summary: searchRoles
description: Search Roles
tags:
- Roles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleSearchInput'
responses:
'200':
description: ok
content:
application/json:
schema:
type: object
properties:
hits:
type: number
results:
type: array
items:
$ref: '#/components/schemas/Role'
/v1/permissions/roles/{roleId}:
get:
operationId: getRole
summary: getRole
x-speakeasy-entity-operation: Role#get
description: Get role by id
tags:
- Roles
parameters:
- name: roleId
x-speakeasy-match: id
in: path
required: true
schema:
$ref: '#/components/schemas/RoleId'
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
put:
operationId: putRole
x-speakeasy-entity-operation: Role#create,update
summary: putRole
description: Create or update role
tags:
- Roles
parameters:
- name: roleId
in: path
x-speakeasy-match: id
required: true
schema:
$ref: '#/components/schemas/RoleId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
examples:
'User role: manager':
description: Example manager role
value:
id: 123:manager
name: Manager
slug: manager
type: user_role
organization_id: '123'
grants:
- action: entity:view
resource: '*'
- action: entity:update
resource: '*'
- action: user:view
- action: user:invite
- action: role:view
- action: role:create
- action: role:assign
- action: message:view
dependencies:
- action: entity:view
resource: message*
- action: entity:view
resource: thread*
- action: message:send
dependencies:
- action: entity:*
resource: message*
- action: entity:*
resource: thread*
- action: workflow:*
'User role: employee':
description: Example employee role
value:
id: 123:employee
name: Employee
slug: employee
type: user_role
organization_id: '123'
grants:
- action: entity:view
resource: '*'
- action: entity:update
resource: '*'
- action: user:view
- action: message:view
dependencies:
- action: entity:view
resource: message*
- action: entity:view
resource: thread*
- action: message:send
dependencies:
- action: entity:*
resource: message*
- action: entity:*
resource: thread*
- action: workflow:execution:*
'User role: administrator':
description: Example administrator role
value:
id: 123:administrator
name: Administrator
slug: administrator
type: user_role
organization_id: '123'
grants:
- action: '*'
resource: '*'
Organization root role:
description: Example organization root role. Must be satisifed for all org queries.
value:
id: 123:root
name: Organization root role
slug: root
type: org_role
organization_id: '123'
grants:
- action: '*'
resource: '*'
- action: webhook:*
effect: deny
Share role:
description: Example share role. This can be assigned to users in other organizations
value:
id: 123:example_share_role
name: Example opportunity share role
slug: example_share_role
type: share_role
organization_id: '123'
grants:
- action: entity:view
resource: opportunity:123456
- action: entity:edit
resource: opportunity:123456
- action: workflow:execution:*
- action: message:*
- action: entity:*
resource: message*
- action: entity:*
resource: thread*
Partner role:
description: Example partner role. This can be given to a partner organization, who can then assign it to their users
value:
id: 123:example_partner_role
name: Example opportunity share role
slug: example_partner_role
type: partner_role
organization_id: '123'
partner_org_id: '456'
grants:
- action: entity:view
resource: opportunity*
- action: entity:edit
resource: opportunity*
- action: workflow:execution:*
- action: message:*
- action: entity:*
resource: message*
- action: entity:*
resource: thread*
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
delete:
operationId: deleteRole
summary: deleteRole
description: Delete role by id
x-speakeasy-entity-operation: Role#delete
tags:
- Roles
parameters:
- name: roleId
in: path
x-speakeasy-match: id
required: true
schema:
$ref: '#/components/schemas/RoleId'
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
/v1/permissions/refresh:
get:
operationId: refreshPermissions
summary: refreshPermissions
description: Makes sure the user has a role in the organization
tags:
- Roles
responses:
'200':
description: Refreshed succesfully
/v1/permissions/assignments/{userId}:
get:
operationId: getAssignedRolesForUser
summary: getAssignedRolesForUser
description: Get list of assigned roles by user id
tags:
- Assignments
parameters:
- name: userId
in: path
required: true
schema:
$ref: '#/components/schemas/UserId'
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Assignments'
put:
operationId: assignRoles
summary: assignRoles
description: Assign / unassign roles to users.
tags:
- Assignments
parameters:
- name: userId
in: path
x-speakeasy-match: "user_id"
required: true
schema:
$ref: '#/components/schemas/UserId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Assignments'
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Assignments'
/v1/permissions/assignments/{userId}/{roleId}:
post:
x-speakeasy-entity-operation: Assignment#create
operationId: addAssignment
summary: addAssignment
description: |
Assign a user to a role.
Use the `x-epilot-org-id` header to assign share roles to users in other orgs
tags:
- Assignments
parameters:
- name: userId
in: path
x-speakeasy-match: "user_id"
required: true
schema:
$ref: '#/components/schemas/UserId'
- name: roleId
in: path
required: true
schema:
$ref: '#/components/schemas/RoleId'
responses:
'201':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Assignment'
delete:
operationId: removeAssignment
summary: removeAssignment
x-speakeasy-entity-operation: Assignment#delete
description: Remove role assignment from user
tags:
- Assignments
parameters:
- name: userId
in: path
x-speakeasy-match: "user_id"
required: true
schema:
$ref: '#/components/schemas/UserId'
- name: roleId
in: path
required: true
schema:
$ref: '#/components/schemas/RoleId'
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Assignment'
/v1/permissions/assignments:
get:
operationId: listAllAssignments
summary: listAllAssignments
description: Returns list of all assignments in organization
tags:
- Assignments
responses:
'200':
description: ok
content:
application/json:
schema:
type: object
properties:
assignments:
type: array
items:
$ref: '#/components/schemas/Assignment'
components:
securitySchemes:
EpilotAuth:
type: http
scheme: bearer
description: Authorization header with epilot OAuth2 bearer token
bearerFormat: JWT
EpilotOrg:
description: Overrides the target organization to allow shared tenantaccess
name: x-epilot-org-id
in: header
type: apiKey
schemas:
Grant:
type: object
properties:
action:
type: string
example: entity-read
resource:
type: string
example: entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947
effect:
type: string
default: allow
enum:
- allow
- deny
required:
- action
GrantWithDependencies:
allOf:
- $ref: '#/components/schemas/Grant'
- type: object
properties:
dependencies:
description: Provided additional dependencies, exploded when storing the role
type: array
items:
$ref: '#/components/schemas/Grant'
RoleId:
type: string
example: 123:owner
description: 'Format: <organization_id>:<slug>'
BaseRole:
type: object
properties:
id:
$ref: '#/components/schemas/RoleId'
name:
type: string
example: Owner
description: Human-friendly name for the role
slug:
type: string
example: owner
description: URL-friendly name for the role
type:
type: string
description: Type of the role
expires_at:
type: string
format: date-time
example: '2028-07-21T17:32:28Z'
description: date and time then the role will expire
organization_id:
$ref: '#/components/schemas/OrganizationId'
grants:
type: array
items:
$ref: '#/components/schemas/Grant'
description: List of grants (permissions) applied to the role
required:
- id
- name
- slug
- type
- organization_id
- grants
UserRole:
title: UserRole
allOf:
- $ref: '#/components/schemas/BaseRole'
- description: A standard user role. Must be explicitly assigned to users.
properties:
type:
enum:
- user_role
OrgRole:
title: OrgRole
allOf:
- $ref: '#/components/schemas/BaseRole'
- description: A role automatically applied to all users in an organization.
properties:
type:
enum:
- org_role
ShareRole:
title: ShareRole
allOf:
- $ref: '#/components/schemas/BaseRole'
- description: A role that can be assigned to users in other organizations for sharing purposes.
properties:
type:
enum:
- share_role
PartnerRole:
title: PartnerRole
allOf:
- $ref: '#/components/schemas/BaseRole'
- description: A role that appears in another organization's role list that can be assigned but not modified by the partner organization.
properties:
type:
enum:
- partner_role
partner_org_id:
allOf:
- description: Partner organization who can assign this role to their users.
- $ref: '#/components/schemas/OrganizationId'
Role:
x-speakeasy-entity: Role
oneOf:
- $ref: '#/components/schemas/UserRole'
- $ref: '#/components/schemas/OrgRole'
- $ref: '#/components/schemas/ShareRole'
- $ref: '#/components/schemas/PartnerRole'
RolePayload:
oneOf:
- allOf:
- $ref: '#/components/schemas/UserRole'
- properties:
grants:
type: array
items:
$ref: '#/components/schemas/GrantWithDependencies'
- allOf:
- $ref: '#/components/schemas/OrgRole'
- properties:
grants:
type: array
items:
$ref: '#/components/schemas/GrantWithDependencies'
- allOf:
- $ref: '#/components/schemas/ShareRole'
- properties:
grants:
type: array
items:
$ref: '#/components/schemas/GrantWithDependencies'
- allOf:
- $ref: '#/components/schemas/PartnerRole'
- properties:
grants:
type: array
items:
$ref: '#/components/schemas/GrantWithDependencies'
Assignment:
type: object
description: A role attached to an user
x-speakeasy-entity: Assignment
properties:
user_id:
$ref: '#/components/schemas/UserId'
roles:
type: array
items:
$ref: '#/components/schemas/RoleId'
OrgAssignments:
type: object
description: All roles attached to an users of an organization
properties:
organization_id:
$ref: '#/components/schemas/OrganizationId'
assignments:
type: array
items:
$ref: '#/components/schemas/Assignment'
OrgRoles:
type: object
description: All roles attached to an users of an organization
properties:
organization_id:
$ref: '#/components/schemas/OrganizationId'
roles:
type: array
items:
$ref: '#/components/schemas/Role'
Assignments:
type: array
description: List of role ids attached to an user
items:
$ref: '#/components/schemas/RoleId'
UserId:
type: string
example: '1'
description: Id of a user
OrganizationId:
type: string
example: '123'
description: Id of an organization
Slug:
type: string
example: owner
description: Slug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug
RoleSearchInput:
type: object
properties:
role_ids:
type: array
description: List of role ids to filter by
example:
- 123:manager
- 456:owner
items:
$ref: '#/components/schemas/RoleId'
org_ids:
type: array
description: List of organization ids to filter by
example:
- '123'
- '456'
items:
$ref: '#/components/schemas/OrganizationId'
slugs:
type: array
description: List of role slugs to filter by
example:
- manager
- owner
items:
$ref: '#/components/schemas/Slug'
query:
type: string
description: Input to search across fields
example: Administrator
limit:
type: number
description: The Number of roles to return
example: 1
minimum: 1
default: 50
offset:
type: number
description: The number of roles to skip before starting to collect the result set
example: 1
minimum: 1
default: 0
servers:
- url: https://permissions.sls.epilot.io