-
Notifications
You must be signed in to change notification settings - Fork 0
/
pap-api.yml
281 lines (273 loc) · 7.35 KB
/
pap-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
swagger: "2.0"
info:
version: 1.0.0
title: AGILE Policy Administration Point API
description: API for the AGILE PAP
specification
license:
name: MIT
url: http://agilegw.local/
host: agilegw.local
basePath: /api/v1/
schemes:
- http
consumes:
- application/json
produces:
- application/json
paths:
/pap/{entityType}/{entityId}:
parameters:
-
name: entityType
in: path
description: 'Entity type'
required: true
type: string
-
name: entityId
in: path
description: 'Entity id. This id is only unique for a certain entity type'
required: true
type: string
get:
operationId: ReadEntityPolicy
tags:
- Policy
description: 'Returns the policy for an entity.'
responses:
'200':
description: 'Policy read done'
schema:
$ref: '#/definitions/Policy'
examples:
application/json:
flows:
read:
flows:
-
op: read
locks:
hasType:
-
lock: hasType
args:
-
/user
not: false
write:
flows:
-
op: write
locks:
isOnwer:
-
lock: isOwner
not: false
'401':
description: 'Not authenticated'
'403':
description: Forbidden
'404':
description: 'No entity found'
'500':
description: 'Unexpected error'
/pap/{entityType}/{entityId}/{field}:
parameters:
-
name: entityType
in: path
description: 'Entity type'
required: true
type: string
-
name: entityId
in: path
description: 'Entity id. This id is only unique for a certain entity type'
required: true
type: string
-
name: field
in: path
description: 'Field within the Policy e.g. password or actions.status'
required: true
type: string
get:
operationId: ReadFieldEntityPolicy
tags:
- Policy
description: 'Returns the policy for a field within a policy structure for an entity.'
responses:
'200':
description: 'Policy update done'
schema:
$ref: '#/definitions/Policy'
examples:
application/json:
flows:
read:
flows:
-
op: read
locks:
hasType:
-
lock: hasType
args:
-
/user
not: false
write:
flows:
-
op: write
locks:
isOnwer:
-
lock: isOwner
not: false
'401':
description: 'Not authenticated'
'403':
description: Forbidden
'404':
description: 'No entity found'
'500':
description: 'Unexpected error'
delete:
operationId: DeleteFieldEntityPolicy
tags:
- Policy
description: 'Returns the resulting policy structure for the entity after deletion.'
responses:
'200':
description: 'Policy read done'
schema:
$ref: '#/definitions/Policy'
examples:
application/json:
flows:
read:
flows:
-
op: read
locks:
hasType:
-
lock: hasType
args:
-
/user
not: false
write:
flows:
-
op: write
locks:
isOnwer:
-
lock: isOwner
not: false
'401':
description: 'Not authenticated'
'403':
description: Forbidden
'404':
description: 'No entity found'
'500':
description: 'Unexpected error'
put:
operationId: SetFieldEntityPolicy
tags:
- Policy
description: 'Sets a policy for a field and returns the resulting policy structure for the entity after the update.'
parameters:
-
name: policy
in: body
description: 'the entity to be stored'
required: true
schema:
type: object
properties:
policy:
type: array
items:
$ref: '#/definitions/PolicyBlock'
responses:
'200':
description: 'Policy read done'
schema:
$ref: '#/definitions/Policy'
examples:
application/json:
flows:
read:
flows:
-
op: read
locks:
hasType:
-
lock: hasType
args:
-
/user
not: false
write:
flows:
-
op: write
locks:
isOnwer:
-
lock: isOwner
not: false
'401':
description: 'Not authenticated'
'403':
description: Forbidden
'404':
description: 'No entity found'
'500':
description: 'Unexpected error'
definitions:
PolicyBlock:
description: 'Contains a Policy Block. Inside each lock there cab be keys referencing the name of a lock and inside there is a representation of the lock as it is configured in the policies, i.e. it has a lock attribute of type string and it has an array called args which includes strings'
type: object
properties:
op:
type: string
locks:
type: object
example:
op: read
locks:
-
lock: hasType
args:
-
user
-
lock: attrEq
args:
-
role
-
admin
Policy:
description: 'Contains a Policy according to UPFRont format.'
type: object
properties:
flows:
type: array
items:
$ref: '#/definitions/PolicyBlock'
read:
type: array
items:
$ref: '#/definitions/PolicyBlock'
write:
type: array
items:
$ref: '#/definitions/PolicyBlock'