-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaccess_grants.yaml
More file actions
320 lines (320 loc) · 12.5 KB
/
Copy pathaccess_grants.yaml
File metadata and controls
320 lines (320 loc) · 12.5 KB
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
---
- title: Create an Access Grant for devices
description:
Creates a new Access Grant that gives a user identity a PIN code on one
or more devices, such as standalone smart locks.
request:
path: /access_grants/create
parameters:
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
device_ids:
- 6ba7b811-9dad-11d1-80b4-00c04fd430c8
requested_access_methods:
- mode: code
starts_at: '2025-06-16T16:54:17.946606Z'
ends_at: '2025-06-18T16:54:17.946606Z'
response:
body:
access_grant:
access_grant_id: ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-18T16:54:17.946606Z'
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
starts_at: '2025-06-16T16:54:17.946606Z'
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7
- title: Create an Access Grant using spaces
description: Creates a new Access Grant using space IDs and an existing user identity.
request:
path: /access_grants/create
parameters:
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
requested_access_methods:
- mode: code
- mode: card
- mode: mobile_key
starts_at: '2025-06-16T16:54:17.946606Z'
ends_at: '2025-06-18T16:54:17.946606Z'
response:
body:
access_grant:
access_grant_id: ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-18T16:54:17.946606Z'
instant_key_url: https://ik.seam.co/ABCXYZ
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- display_name: Card Credential
mode: card
created_at: '2025-06-16T16:54:19.946606Z'
created_access_method_ids:
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- display_name: Mobile Key Credential
mode: mobile_key
created_at: '2025-06-16T16:54:21.946606Z'
created_access_method_ids:
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
starts_at: '2025-06-16T16:54:17.946606Z'
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7
- title: Create an Access Grant using entrances and devices
description:
Creates a new Access Grant using entrance IDs and device IDs and an
existing user identity.
request:
path: /access_grants/create
parameters:
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
acs_entrance_ids:
- f47ac10b-58cc-4372-a567-0e02b2c3d479
- 550e8400-e29b-41d4-a716-446655440001
device_ids:
- 6ba7b811-9dad-11d1-80b4-00c04fd430c8
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
requested_access_methods:
- mode: code
- mode: card
- mode: mobile_key
starts_at: '2025-06-16T16:54:17.946606Z'
ends_at: '2025-06-18T16:54:17.946606Z'
response:
body:
access_grant:
access_grant_id: ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-18T16:54:17.946606Z'
instant_key_url: https://ik.seam.co/ABCXYZ
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- display_name: Card Credential
mode: card
created_at: '2025-06-16T16:54:19.946606Z'
created_access_method_ids:
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- display_name: Mobile Key Credential
mode: mobile_key
created_at: '2025-06-16T16:54:21.946606Z'
created_access_method_ids:
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
starts_at: '2025-06-16T16:54:17.946606Z'
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7
- title: Create an Access Grant including a new user identity
description:
Creates a new Access Grant and create a new user identity as part of
the same operation.
request:
path: /access_grants/create
parameters:
user_identity:
full_name: Jane Doe
email_address: jane.doe@example.com
phone_number: '+1555551003'
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
requested_access_methods:
- mode: code
- mode: card
- mode: mobile_key
starts_at: '2025-06-16T16:54:17.946606Z'
ends_at: '2025-06-18T16:54:17.946606Z'
response:
body:
access_grant:
access_grant_id: ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-18T16:54:17.946606Z'
instant_key_url: https://ik.seam.co/ABCXYZ
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- display_name: Card Credential
mode: card
created_at: '2025-06-16T16:54:19.946606Z'
created_access_method_ids:
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- display_name: Mobile Key Credential
mode: mobile_key
created_at: '2025-06-16T16:54:21.946606Z'
created_access_method_ids:
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
starts_at: '2025-06-16T16:54:17.946606Z'
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7
- title: Delete an Access Grant
description: Deletes an Access Grant.
request:
path: /access_grants/delete
parameters:
access_grant_id: 403ea27b-af76-4a48-ace9-8f9498f4c25c
response:
body: null
- title: Get an Access Grant
description: Returns a specified Access Grant.
request:
path: /access_grants/get
parameters:
access_grant_id: 704eadf0-a0a2-4715-b0e1-2f002dc1b6e0
response:
body:
access_grant:
access_grant_id: 704eadf0-a0a2-4715-b0e1-2f002dc1b6e0
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-18T16:54:17.946606Z'
instant_key_url: https://ik.seam.co/ABCXYZ
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- display_name: Card Credential
mode: card
created_at: '2025-06-16T16:54:19.946606Z'
created_access_method_ids:
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- display_name: Mobile Key Credential
mode: mobile_key
created_at: '2025-06-16T16:54:21.946606Z'
created_access_method_ids:
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
starts_at: '2025-06-16T16:54:17.946606Z'
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7
- title: List Access Grants
description: Returns a list of all Access Grants.
request:
path: /access_grants/list
parameters:
user_identity_id: f7620fcf-d92f-471e-b97e-3806daeebd40
acs_system_id: 9f169742-048a-4105-84e3-bd1e0f9dc790
acs_entrance_id: 2673b363-4748-4a64-8075-f669c862ec74
space_id: 1d20c47d-3cc0-41ca-9917-bc798d071543
response:
body:
access_grants:
- access_grant:
access_grant_id: 704eadf0-a0a2-4715-b0e1-2f002dc1b6e0
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-18T16:54:17.946606Z'
instant_key_url: https://ik.seam.co/ABCXYZ
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- display_name: Card Credential
mode: card
created_at: '2025-06-16T16:54:19.946606Z'
created_access_method_ids:
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- display_name: Mobile Key Credential
mode: mobile_key
created_at: '2025-06-16T16:54:21.946606Z'
created_access_method_ids:
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
starts_at: '2025-06-16T16:54:17.946606Z'
user_identity_id: f7620fcf-d92f-471e-b97e-3806daeebd40
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7
- title: Update an Access Grant
description: Updates an existing Access Grant's time window.
request:
path: /access_grants/update
parameters:
access_grant_id: 4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1
starts_at: '2025-06-19T18:01:32.000Z'
ends_at: '2025-06-22T13:24:50.000Z'
response:
body:
access_grant:
access_grant_id: 4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1
access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
created_at: '2025-06-16T16:54:17.946606Z'
display_name: My Access Grant
ends_at: '2025-06-22T13:24:50.000Z'
requested_access_methods:
- display_name: PIN Code Credential
mode: code
created_at: '2025-06-16T16:54:17.946606Z'
created_access_method_ids:
- a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d
- display_name: Card Credential
mode: card
created_at: '2025-06-16T16:54:19.946606Z'
created_access_method_ids:
- 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f
- display_name: Mobile Key Credential
mode: mobile_key
created_at: '2025-06-16T16:54:21.946606Z'
created_access_method_ids:
- c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f
space_ids:
- 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
- 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a
starts_at: '2025-06-19T18:01:32.000Z'
user_identity_id: e3d736c1-540d-4d10-83e5-9a4e135453b4
workspace_id: 750fc0bc-4450-4356-8d9f-18c6a3a6b2c7