-
Notifications
You must be signed in to change notification settings - Fork 215
/
policy.yml
313 lines (298 loc) · 11.2 KB
/
policy.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
# Copyright (c) 2020 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0
#
# SPDX-License-Identifier: EPL-2.0
get:
summary: Retrieve a specific policy
description: |-
Returns the complete policy identified by the `policyId` path parameter. The
response contains the policy as JSON object.
Tip: If you don't know the policy ID of a thing, request it via GET `/things/{thingId}`.
Optionally, you can use the field selectors (see parameter `fields`) to only get specific fields,
which you are interested in.
### Example:
Use the field selector `_revision` to retrieve the revision of the policy.
tags:
- Policies
parameters:
- $ref: '../../parameters/policyIdPathParam.yml'
- $ref: '../../parameters/policyFieldsQueryParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
responses:
'200':
description: |-
The request successfully returned completed and returned is the
policy.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
content:
application/json:
schema:
$ref: '../../schemas/policies/policy.yml'
'304':
$ref: '../../responses/notModified.yml'
'400':
description: |-
The request could not be completed. Possible reasons:
* the `policyId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The policy with the given ID was
not found in the context of the authenticated user.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
put:
summary: Create or update a policy with a specified ID
description: |-
Create or update the policy specified by the policyId path parameter.
* If you set a new policyId in the path, a new policy will be created.
* If you set an existing policyId in the path, the policy will be updated.
### Create a new policy
At the initial creation of a policy, at least one valid entry is required. However, you can create a full-fledged policy all at once.
By default the authorized subject needs WRITE permission on the root resource of the created policy. You can
however omit this check by setting the parameter `allow-policy-lockout` to `true`.
Example: To create a policy for multiple coffee maker things,
which gives **yourself** all permissions on all resources, set the policyId in the path,
e.g. to "com.acme.coffeemaker:policy-01" and the body part, like in the following snippet.
```
{
"entries": {
"DEFAULT": {
"subjects": {
"{{ request:subjectId }}": {
"type": "the creator"
}
},
"resources": {
"policy:/": {
"grant": [
"READ",
"WRITE"
],
"revoke": []
},
"thing:/": {
"grant": [
"READ",
"WRITE"
],
"revoke": []
},
"message:/": {
"grant": [
"READ",
"WRITE"
],
"revoke": []
}
}
}
}
}
```
### Update an existing policy
For updating an existing policy, the authorized subject needs WRITE permission on the policy's root resource.
The ID of a policy cannot be changed after creation. Any `policyId` specified in the request body is therefore ignored.
### Partially update an existing policy
Partial updates are not supported.
If you need to create or update a specific label, resource, or subject, please use the respective sub-resources.
tags:
- Policies
parameters:
- $ref: '../../parameters/policyIdPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/responseRequiredParam.yml'
- $ref: '../../parameters/allowPolicyLockoutParam.yml'
responses:
'201':
description: The policy was successfully created.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
Location:
description: The location of the created policy resource
schema:
type: string
content:
application/json:
schema:
$ref: '../../schemas/policies/newPolicy.yml'
'204':
description: The policy was successfully updated.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the `policyId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
* the JSON body of the policy to be created/modified is invalid
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
You need `WRITE` permission on the root `policy:/` resource,
without any revoke in a deeper path of the policy resource.
(You can omit this check by setting the `allow-policy-lockout` parameter.)
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The policy with the given ID was
not found in the context of the authenticated user.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
'413':
$ref: '../../responses/entityTooLarge.yml'
requestBody:
content:
application/json:
schema:
$ref: '../../schemas/policies/newPolicy.yml'
example: {
"entries": {
"DEFAULT": {
"subjects": {
"{{ request:subjectId }}": {
"type": "the creator"
}
},
"resources": {
"policy:/": {
"grant": [
"READ",
"WRITE"
],
"revoke": []
},
"thing:/": {
"grant": [
"READ",
"WRITE"
],
"revoke": []
},
"message:/": {
"grant": [
"READ",
"WRITE"
],
"revoke": []
}
}
}
}
}
description: |-
JSON representation of the policy.
Use the placeholder `{{ request:subjectId }}` in order to let the
backend insert the authenticated subjectId of the HTTP request.
required: true
delete:
summary: Delete a specific policy
description: |-
Deletes the policy identified by the `policyId` path parameter. Deleting
a policy does not implicitly delete other entities (e.g. things) which
use this policy.
Note: Delete the respective things **before** deleting the
policy, otherwise nobody has permission to read, update, or delete the things.
If you accidentally run into such a scenario, re-create the policy via
PUT `/policies/{policyId}`.
tags:
- Policies
parameters:
- $ref: '../../parameters/policyIdPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/responseRequiredParam.yml'
responses:
'204':
description: The policy was successfully deleted.
'400':
description: |-
The request could not be completed. Possible reasons:
* the `policyId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
You need `WRITE` permission on the root `policy:/` resource,
without any revoke in a deeper path of the policy resource.having any revoke.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The policy with the given ID was
not found in the context of the authenticated user.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'