@seamapi/types 1.278.0 → 1.280.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +678 -147
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1813 -0
- package/lib/seam/connect/models/acs/acs-credential.js +81 -22
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +169 -0
- package/lib/seam/connect/openapi.js +619 -114
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1644 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +107 -28
- package/src/lib/seam/connect/openapi.ts +765 -114
- package/src/lib/seam/connect/route-types.ts +1644 -0
|
@@ -241,20 +241,49 @@ export default {
|
|
|
241
241
|
type: 'object',
|
|
242
242
|
},
|
|
243
243
|
acs_credential: {
|
|
244
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
244
245
|
properties: {
|
|
245
246
|
access_method: {
|
|
247
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
246
248
|
enum: ['code', 'card', 'mobile_key'],
|
|
247
249
|
type: 'string',
|
|
248
250
|
},
|
|
249
|
-
acs_credential_id: {
|
|
251
|
+
acs_credential_id: {
|
|
252
|
+
description: 'ID of the credential.',
|
|
253
|
+
format: 'uuid',
|
|
254
|
+
type: 'string',
|
|
255
|
+
},
|
|
250
256
|
acs_credential_pool_id: { format: 'uuid', type: 'string' },
|
|
251
|
-
acs_system_id: {
|
|
252
|
-
|
|
257
|
+
acs_system_id: {
|
|
258
|
+
description: 'ID of the access control system that contains the credential.',
|
|
259
|
+
format: 'uuid',
|
|
260
|
+
type: 'string',
|
|
261
|
+
},
|
|
262
|
+
acs_user_id: {
|
|
263
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
264
|
+
format: 'uuid',
|
|
265
|
+
type: 'string',
|
|
266
|
+
},
|
|
253
267
|
card_number: { nullable: true, type: 'string' },
|
|
254
|
-
code: {
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
268
|
+
code: {
|
|
269
|
+
description: 'Access (PIN) code for the credential.',
|
|
270
|
+
nullable: true,
|
|
271
|
+
type: 'string',
|
|
272
|
+
},
|
|
273
|
+
created_at: {
|
|
274
|
+
description: 'Date and time at which the credential was created.',
|
|
275
|
+
format: 'date-time',
|
|
276
|
+
type: 'string',
|
|
277
|
+
},
|
|
278
|
+
display_name: {
|
|
279
|
+
description: 'Display name that corresponds to the credential type.',
|
|
280
|
+
minLength: 1,
|
|
281
|
+
type: 'string',
|
|
282
|
+
},
|
|
283
|
+
ends_at: {
|
|
284
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
285
|
+
type: 'string',
|
|
286
|
+
},
|
|
258
287
|
errors: {
|
|
259
288
|
items: {
|
|
260
289
|
properties: {
|
|
@@ -267,6 +296,7 @@ export default {
|
|
|
267
296
|
type: 'array',
|
|
268
297
|
},
|
|
269
298
|
external_type: {
|
|
299
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
270
300
|
enum: [
|
|
271
301
|
'pti_card',
|
|
272
302
|
'brivo_credential',
|
|
@@ -276,19 +306,37 @@ export default {
|
|
|
276
306
|
],
|
|
277
307
|
type: 'string',
|
|
278
308
|
},
|
|
279
|
-
external_type_display_name: {
|
|
309
|
+
external_type_display_name: {
|
|
310
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
311
|
+
type: 'string',
|
|
312
|
+
},
|
|
280
313
|
is_issued: { type: 'boolean' },
|
|
281
|
-
is_latest_desired_state_synced_with_provider: {
|
|
314
|
+
is_latest_desired_state_synced_with_provider: {
|
|
315
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
316
|
+
type: 'boolean',
|
|
317
|
+
},
|
|
282
318
|
is_managed: { enum: [true], type: 'boolean' },
|
|
283
|
-
is_multi_phone_sync_credential: {
|
|
319
|
+
is_multi_phone_sync_credential: {
|
|
320
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
321
|
+
type: 'boolean',
|
|
322
|
+
},
|
|
284
323
|
issued_at: { format: 'date-time', nullable: true, type: 'string' },
|
|
285
324
|
latest_desired_state_synced_with_provider_at: {
|
|
325
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
286
326
|
format: 'date-time',
|
|
287
327
|
type: 'string',
|
|
288
328
|
},
|
|
289
|
-
parent_acs_credential_id: {
|
|
290
|
-
|
|
329
|
+
parent_acs_credential_id: {
|
|
330
|
+
description: 'ID of the parent credential.',
|
|
331
|
+
format: 'uuid',
|
|
332
|
+
type: 'string',
|
|
333
|
+
},
|
|
334
|
+
starts_at: {
|
|
335
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
336
|
+
type: 'string',
|
|
337
|
+
},
|
|
291
338
|
visionline_metadata: {
|
|
339
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
292
340
|
properties: {
|
|
293
341
|
auto_join: { type: 'boolean' },
|
|
294
342
|
card_function_type: { enum: ['guest', 'staff'], type: 'string' },
|
|
@@ -322,7 +370,11 @@ export default {
|
|
|
322
370
|
},
|
|
323
371
|
type: 'array',
|
|
324
372
|
},
|
|
325
|
-
workspace_id: {
|
|
373
|
+
workspace_id: {
|
|
374
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
375
|
+
format: 'uuid',
|
|
376
|
+
type: 'string',
|
|
377
|
+
},
|
|
326
378
|
},
|
|
327
379
|
required: [
|
|
328
380
|
'acs_credential_id',
|
|
@@ -1242,6 +1294,7 @@ export default {
|
|
|
1242
1294
|
type: 'string',
|
|
1243
1295
|
},
|
|
1244
1296
|
visionline_metadata: {
|
|
1297
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
1245
1298
|
properties: {
|
|
1246
1299
|
cancelled: { type: 'boolean' },
|
|
1247
1300
|
card_format: {
|
|
@@ -1295,23 +1348,52 @@ export default {
|
|
|
1295
1348
|
nullable: true,
|
|
1296
1349
|
oneOf: [
|
|
1297
1350
|
{
|
|
1351
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
1298
1352
|
properties: {
|
|
1299
1353
|
access_method: {
|
|
1354
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1300
1355
|
enum: ['code', 'card', 'mobile_key'],
|
|
1301
1356
|
type: 'string',
|
|
1302
1357
|
},
|
|
1303
|
-
acs_credential_id: {
|
|
1358
|
+
acs_credential_id: {
|
|
1359
|
+
description: 'ID of the credential.',
|
|
1360
|
+
format: 'uuid',
|
|
1361
|
+
type: 'string',
|
|
1362
|
+
},
|
|
1304
1363
|
acs_credential_pool_id: {
|
|
1305
1364
|
format: 'uuid',
|
|
1306
1365
|
type: 'string',
|
|
1307
1366
|
},
|
|
1308
|
-
acs_system_id: {
|
|
1309
|
-
|
|
1367
|
+
acs_system_id: {
|
|
1368
|
+
description: 'ID of the access control system that contains the credential.',
|
|
1369
|
+
format: 'uuid',
|
|
1370
|
+
type: 'string',
|
|
1371
|
+
},
|
|
1372
|
+
acs_user_id: {
|
|
1373
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
1374
|
+
format: 'uuid',
|
|
1375
|
+
type: 'string',
|
|
1376
|
+
},
|
|
1310
1377
|
card_number: { nullable: true, type: 'string' },
|
|
1311
|
-
code: {
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1378
|
+
code: {
|
|
1379
|
+
description: 'Access (PIN) code for the credential.',
|
|
1380
|
+
nullable: true,
|
|
1381
|
+
type: 'string',
|
|
1382
|
+
},
|
|
1383
|
+
created_at: {
|
|
1384
|
+
description: 'Date and time at which the credential was created.',
|
|
1385
|
+
format: 'date-time',
|
|
1386
|
+
type: 'string',
|
|
1387
|
+
},
|
|
1388
|
+
display_name: {
|
|
1389
|
+
description: 'Display name that corresponds to the credential type.',
|
|
1390
|
+
minLength: 1,
|
|
1391
|
+
type: 'string',
|
|
1392
|
+
},
|
|
1393
|
+
ends_at: {
|
|
1394
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
1395
|
+
type: 'string',
|
|
1396
|
+
},
|
|
1315
1397
|
errors: {
|
|
1316
1398
|
items: {
|
|
1317
1399
|
properties: {
|
|
@@ -1324,6 +1406,7 @@ export default {
|
|
|
1324
1406
|
type: 'array',
|
|
1325
1407
|
},
|
|
1326
1408
|
external_type: {
|
|
1409
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1327
1410
|
enum: [
|
|
1328
1411
|
'pti_card',
|
|
1329
1412
|
'brivo_credential',
|
|
@@ -1333,28 +1416,41 @@ export default {
|
|
|
1333
1416
|
],
|
|
1334
1417
|
type: 'string',
|
|
1335
1418
|
},
|
|
1336
|
-
external_type_display_name: {
|
|
1419
|
+
external_type_display_name: {
|
|
1420
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1421
|
+
type: 'string',
|
|
1422
|
+
},
|
|
1337
1423
|
is_issued: { type: 'boolean' },
|
|
1338
1424
|
is_latest_desired_state_synced_with_provider: {
|
|
1425
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1339
1426
|
type: 'boolean',
|
|
1340
1427
|
},
|
|
1341
1428
|
is_managed: { enum: [true], type: 'boolean' },
|
|
1342
|
-
is_multi_phone_sync_credential: {
|
|
1429
|
+
is_multi_phone_sync_credential: {
|
|
1430
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
1431
|
+
type: 'boolean',
|
|
1432
|
+
},
|
|
1343
1433
|
issued_at: {
|
|
1344
1434
|
format: 'date-time',
|
|
1345
1435
|
nullable: true,
|
|
1346
1436
|
type: 'string',
|
|
1347
1437
|
},
|
|
1348
1438
|
latest_desired_state_synced_with_provider_at: {
|
|
1439
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1349
1440
|
format: 'date-time',
|
|
1350
1441
|
type: 'string',
|
|
1351
1442
|
},
|
|
1352
1443
|
parent_acs_credential_id: {
|
|
1444
|
+
description: 'ID of the parent credential.',
|
|
1353
1445
|
format: 'uuid',
|
|
1354
1446
|
type: 'string',
|
|
1355
1447
|
},
|
|
1356
|
-
starts_at: {
|
|
1448
|
+
starts_at: {
|
|
1449
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
1450
|
+
type: 'string',
|
|
1451
|
+
},
|
|
1357
1452
|
visionline_metadata: {
|
|
1453
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
1358
1454
|
properties: {
|
|
1359
1455
|
auto_join: { type: 'boolean' },
|
|
1360
1456
|
card_function_type: {
|
|
@@ -1391,7 +1487,11 @@ export default {
|
|
|
1391
1487
|
},
|
|
1392
1488
|
type: 'array',
|
|
1393
1489
|
},
|
|
1394
|
-
workspace_id: {
|
|
1490
|
+
workspace_id: {
|
|
1491
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
1492
|
+
format: 'uuid',
|
|
1493
|
+
type: 'string',
|
|
1494
|
+
},
|
|
1395
1495
|
},
|
|
1396
1496
|
required: [
|
|
1397
1497
|
'acs_credential_id',
|
|
@@ -1407,23 +1507,52 @@ export default {
|
|
|
1407
1507
|
type: 'object',
|
|
1408
1508
|
},
|
|
1409
1509
|
{
|
|
1510
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
1410
1511
|
properties: {
|
|
1411
1512
|
access_method: {
|
|
1513
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1412
1514
|
enum: ['code', 'card', 'mobile_key'],
|
|
1413
1515
|
type: 'string',
|
|
1414
1516
|
},
|
|
1415
|
-
acs_credential_id: {
|
|
1517
|
+
acs_credential_id: {
|
|
1518
|
+
description: 'ID of the credential.',
|
|
1519
|
+
format: 'uuid',
|
|
1520
|
+
type: 'string',
|
|
1521
|
+
},
|
|
1416
1522
|
acs_credential_pool_id: {
|
|
1417
1523
|
format: 'uuid',
|
|
1418
1524
|
type: 'string',
|
|
1419
1525
|
},
|
|
1420
|
-
acs_system_id: {
|
|
1421
|
-
|
|
1526
|
+
acs_system_id: {
|
|
1527
|
+
description: 'ID of the access control system that contains the credential.',
|
|
1528
|
+
format: 'uuid',
|
|
1529
|
+
type: 'string',
|
|
1530
|
+
},
|
|
1531
|
+
acs_user_id: {
|
|
1532
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
1533
|
+
format: 'uuid',
|
|
1534
|
+
type: 'string',
|
|
1535
|
+
},
|
|
1422
1536
|
card_number: { nullable: true, type: 'string' },
|
|
1423
|
-
code: {
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1537
|
+
code: {
|
|
1538
|
+
description: 'Access (PIN) code for the credential.',
|
|
1539
|
+
nullable: true,
|
|
1540
|
+
type: 'string',
|
|
1541
|
+
},
|
|
1542
|
+
created_at: {
|
|
1543
|
+
description: 'Date and time at which the credential was created.',
|
|
1544
|
+
format: 'date-time',
|
|
1545
|
+
type: 'string',
|
|
1546
|
+
},
|
|
1547
|
+
display_name: {
|
|
1548
|
+
description: 'Display name that corresponds to the credential type.',
|
|
1549
|
+
minLength: 1,
|
|
1550
|
+
type: 'string',
|
|
1551
|
+
},
|
|
1552
|
+
ends_at: {
|
|
1553
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
1554
|
+
type: 'string',
|
|
1555
|
+
},
|
|
1427
1556
|
errors: {
|
|
1428
1557
|
items: {
|
|
1429
1558
|
properties: {
|
|
@@ -1436,6 +1565,7 @@ export default {
|
|
|
1436
1565
|
type: 'array',
|
|
1437
1566
|
},
|
|
1438
1567
|
external_type: {
|
|
1568
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1439
1569
|
enum: [
|
|
1440
1570
|
'pti_card',
|
|
1441
1571
|
'brivo_credential',
|
|
@@ -1445,28 +1575,41 @@ export default {
|
|
|
1445
1575
|
],
|
|
1446
1576
|
type: 'string',
|
|
1447
1577
|
},
|
|
1448
|
-
external_type_display_name: {
|
|
1578
|
+
external_type_display_name: {
|
|
1579
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1580
|
+
type: 'string',
|
|
1581
|
+
},
|
|
1449
1582
|
is_issued: { type: 'boolean' },
|
|
1450
1583
|
is_latest_desired_state_synced_with_provider: {
|
|
1584
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1451
1585
|
type: 'boolean',
|
|
1452
1586
|
},
|
|
1453
1587
|
is_managed: { enum: [false], type: 'boolean' },
|
|
1454
|
-
is_multi_phone_sync_credential: {
|
|
1588
|
+
is_multi_phone_sync_credential: {
|
|
1589
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
1590
|
+
type: 'boolean',
|
|
1591
|
+
},
|
|
1455
1592
|
issued_at: {
|
|
1456
1593
|
format: 'date-time',
|
|
1457
1594
|
nullable: true,
|
|
1458
1595
|
type: 'string',
|
|
1459
1596
|
},
|
|
1460
1597
|
latest_desired_state_synced_with_provider_at: {
|
|
1598
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1461
1599
|
format: 'date-time',
|
|
1462
1600
|
type: 'string',
|
|
1463
1601
|
},
|
|
1464
1602
|
parent_acs_credential_id: {
|
|
1603
|
+
description: 'ID of the parent credential.',
|
|
1465
1604
|
format: 'uuid',
|
|
1466
1605
|
type: 'string',
|
|
1467
1606
|
},
|
|
1468
|
-
starts_at: {
|
|
1607
|
+
starts_at: {
|
|
1608
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
1609
|
+
type: 'string',
|
|
1610
|
+
},
|
|
1469
1611
|
visionline_metadata: {
|
|
1612
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
1470
1613
|
properties: {
|
|
1471
1614
|
auto_join: { type: 'boolean' },
|
|
1472
1615
|
card_function_type: {
|
|
@@ -1503,7 +1646,11 @@ export default {
|
|
|
1503
1646
|
},
|
|
1504
1647
|
type: 'array',
|
|
1505
1648
|
},
|
|
1506
|
-
workspace_id: {
|
|
1649
|
+
workspace_id: {
|
|
1650
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
1651
|
+
format: 'uuid',
|
|
1652
|
+
type: 'string',
|
|
1653
|
+
},
|
|
1507
1654
|
},
|
|
1508
1655
|
required: [
|
|
1509
1656
|
'acs_credential_id',
|
|
@@ -1618,25 +1765,55 @@ export default {
|
|
|
1618
1765
|
action_type: { enum: ['ENCODE_CARD'], type: 'string' },
|
|
1619
1766
|
error: { nullable: true },
|
|
1620
1767
|
result: {
|
|
1768
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
1621
1769
|
oneOf: [
|
|
1622
1770
|
{
|
|
1771
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
1623
1772
|
properties: {
|
|
1624
1773
|
access_method: {
|
|
1774
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1625
1775
|
enum: ['code', 'card', 'mobile_key'],
|
|
1626
1776
|
type: 'string',
|
|
1627
1777
|
},
|
|
1628
|
-
acs_credential_id: {
|
|
1778
|
+
acs_credential_id: {
|
|
1779
|
+
description: 'ID of the credential.',
|
|
1780
|
+
format: 'uuid',
|
|
1781
|
+
type: 'string',
|
|
1782
|
+
},
|
|
1629
1783
|
acs_credential_pool_id: {
|
|
1630
1784
|
format: 'uuid',
|
|
1631
1785
|
type: 'string',
|
|
1632
1786
|
},
|
|
1633
|
-
acs_system_id: {
|
|
1634
|
-
|
|
1787
|
+
acs_system_id: {
|
|
1788
|
+
description: 'ID of the access control system that contains the credential.',
|
|
1789
|
+
format: 'uuid',
|
|
1790
|
+
type: 'string',
|
|
1791
|
+
},
|
|
1792
|
+
acs_user_id: {
|
|
1793
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
1794
|
+
format: 'uuid',
|
|
1795
|
+
type: 'string',
|
|
1796
|
+
},
|
|
1635
1797
|
card_number: { nullable: true, type: 'string' },
|
|
1636
|
-
code: {
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1798
|
+
code: {
|
|
1799
|
+
description: 'Access (PIN) code for the credential.',
|
|
1800
|
+
nullable: true,
|
|
1801
|
+
type: 'string',
|
|
1802
|
+
},
|
|
1803
|
+
created_at: {
|
|
1804
|
+
description: 'Date and time at which the credential was created.',
|
|
1805
|
+
format: 'date-time',
|
|
1806
|
+
type: 'string',
|
|
1807
|
+
},
|
|
1808
|
+
display_name: {
|
|
1809
|
+
description: 'Display name that corresponds to the credential type.',
|
|
1810
|
+
minLength: 1,
|
|
1811
|
+
type: 'string',
|
|
1812
|
+
},
|
|
1813
|
+
ends_at: {
|
|
1814
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
1815
|
+
type: 'string',
|
|
1816
|
+
},
|
|
1640
1817
|
errors: {
|
|
1641
1818
|
items: {
|
|
1642
1819
|
properties: {
|
|
@@ -1649,6 +1826,7 @@ export default {
|
|
|
1649
1826
|
type: 'array',
|
|
1650
1827
|
},
|
|
1651
1828
|
external_type: {
|
|
1829
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1652
1830
|
enum: [
|
|
1653
1831
|
'pti_card',
|
|
1654
1832
|
'brivo_credential',
|
|
@@ -1658,28 +1836,41 @@ export default {
|
|
|
1658
1836
|
],
|
|
1659
1837
|
type: 'string',
|
|
1660
1838
|
},
|
|
1661
|
-
external_type_display_name: {
|
|
1839
|
+
external_type_display_name: {
|
|
1840
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1841
|
+
type: 'string',
|
|
1842
|
+
},
|
|
1662
1843
|
is_issued: { type: 'boolean' },
|
|
1663
1844
|
is_latest_desired_state_synced_with_provider: {
|
|
1845
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1664
1846
|
type: 'boolean',
|
|
1665
1847
|
},
|
|
1666
1848
|
is_managed: { enum: [true], type: 'boolean' },
|
|
1667
|
-
is_multi_phone_sync_credential: {
|
|
1849
|
+
is_multi_phone_sync_credential: {
|
|
1850
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
1851
|
+
type: 'boolean',
|
|
1852
|
+
},
|
|
1668
1853
|
issued_at: {
|
|
1669
1854
|
format: 'date-time',
|
|
1670
1855
|
nullable: true,
|
|
1671
1856
|
type: 'string',
|
|
1672
1857
|
},
|
|
1673
1858
|
latest_desired_state_synced_with_provider_at: {
|
|
1859
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1674
1860
|
format: 'date-time',
|
|
1675
1861
|
type: 'string',
|
|
1676
1862
|
},
|
|
1677
1863
|
parent_acs_credential_id: {
|
|
1864
|
+
description: 'ID of the parent credential.',
|
|
1678
1865
|
format: 'uuid',
|
|
1679
1866
|
type: 'string',
|
|
1680
1867
|
},
|
|
1681
|
-
starts_at: {
|
|
1868
|
+
starts_at: {
|
|
1869
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
1870
|
+
type: 'string',
|
|
1871
|
+
},
|
|
1682
1872
|
visionline_metadata: {
|
|
1873
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
1683
1874
|
properties: {
|
|
1684
1875
|
auto_join: { type: 'boolean' },
|
|
1685
1876
|
card_function_type: {
|
|
@@ -1716,7 +1907,11 @@ export default {
|
|
|
1716
1907
|
},
|
|
1717
1908
|
type: 'array',
|
|
1718
1909
|
},
|
|
1719
|
-
workspace_id: {
|
|
1910
|
+
workspace_id: {
|
|
1911
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
1912
|
+
format: 'uuid',
|
|
1913
|
+
type: 'string',
|
|
1914
|
+
},
|
|
1720
1915
|
},
|
|
1721
1916
|
required: [
|
|
1722
1917
|
'acs_credential_id',
|
|
@@ -1732,23 +1927,52 @@ export default {
|
|
|
1732
1927
|
type: 'object',
|
|
1733
1928
|
},
|
|
1734
1929
|
{
|
|
1930
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
1735
1931
|
properties: {
|
|
1736
1932
|
access_method: {
|
|
1933
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1737
1934
|
enum: ['code', 'card', 'mobile_key'],
|
|
1738
1935
|
type: 'string',
|
|
1739
1936
|
},
|
|
1740
|
-
acs_credential_id: {
|
|
1937
|
+
acs_credential_id: {
|
|
1938
|
+
description: 'ID of the credential.',
|
|
1939
|
+
format: 'uuid',
|
|
1940
|
+
type: 'string',
|
|
1941
|
+
},
|
|
1741
1942
|
acs_credential_pool_id: {
|
|
1742
1943
|
format: 'uuid',
|
|
1743
1944
|
type: 'string',
|
|
1744
1945
|
},
|
|
1745
|
-
acs_system_id: {
|
|
1746
|
-
|
|
1946
|
+
acs_system_id: {
|
|
1947
|
+
description: 'ID of the access control system that contains the credential.',
|
|
1948
|
+
format: 'uuid',
|
|
1949
|
+
type: 'string',
|
|
1950
|
+
},
|
|
1951
|
+
acs_user_id: {
|
|
1952
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
1953
|
+
format: 'uuid',
|
|
1954
|
+
type: 'string',
|
|
1955
|
+
},
|
|
1747
1956
|
card_number: { nullable: true, type: 'string' },
|
|
1748
|
-
code: {
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1957
|
+
code: {
|
|
1958
|
+
description: 'Access (PIN) code for the credential.',
|
|
1959
|
+
nullable: true,
|
|
1960
|
+
type: 'string',
|
|
1961
|
+
},
|
|
1962
|
+
created_at: {
|
|
1963
|
+
description: 'Date and time at which the credential was created.',
|
|
1964
|
+
format: 'date-time',
|
|
1965
|
+
type: 'string',
|
|
1966
|
+
},
|
|
1967
|
+
display_name: {
|
|
1968
|
+
description: 'Display name that corresponds to the credential type.',
|
|
1969
|
+
minLength: 1,
|
|
1970
|
+
type: 'string',
|
|
1971
|
+
},
|
|
1972
|
+
ends_at: {
|
|
1973
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
1974
|
+
type: 'string',
|
|
1975
|
+
},
|
|
1752
1976
|
errors: {
|
|
1753
1977
|
items: {
|
|
1754
1978
|
properties: {
|
|
@@ -1761,6 +1985,7 @@ export default {
|
|
|
1761
1985
|
type: 'array',
|
|
1762
1986
|
},
|
|
1763
1987
|
external_type: {
|
|
1988
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1764
1989
|
enum: [
|
|
1765
1990
|
'pti_card',
|
|
1766
1991
|
'brivo_credential',
|
|
@@ -1770,28 +1995,41 @@ export default {
|
|
|
1770
1995
|
],
|
|
1771
1996
|
type: 'string',
|
|
1772
1997
|
},
|
|
1773
|
-
external_type_display_name: {
|
|
1998
|
+
external_type_display_name: {
|
|
1999
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
2000
|
+
type: 'string',
|
|
2001
|
+
},
|
|
1774
2002
|
is_issued: { type: 'boolean' },
|
|
1775
2003
|
is_latest_desired_state_synced_with_provider: {
|
|
2004
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1776
2005
|
type: 'boolean',
|
|
1777
2006
|
},
|
|
1778
2007
|
is_managed: { enum: [false], type: 'boolean' },
|
|
1779
|
-
is_multi_phone_sync_credential: {
|
|
2008
|
+
is_multi_phone_sync_credential: {
|
|
2009
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
2010
|
+
type: 'boolean',
|
|
2011
|
+
},
|
|
1780
2012
|
issued_at: {
|
|
1781
2013
|
format: 'date-time',
|
|
1782
2014
|
nullable: true,
|
|
1783
2015
|
type: 'string',
|
|
1784
2016
|
},
|
|
1785
2017
|
latest_desired_state_synced_with_provider_at: {
|
|
2018
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1786
2019
|
format: 'date-time',
|
|
1787
2020
|
type: 'string',
|
|
1788
2021
|
},
|
|
1789
2022
|
parent_acs_credential_id: {
|
|
2023
|
+
description: 'ID of the parent credential.',
|
|
1790
2024
|
format: 'uuid',
|
|
1791
2025
|
type: 'string',
|
|
1792
2026
|
},
|
|
1793
|
-
starts_at: {
|
|
2027
|
+
starts_at: {
|
|
2028
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
2029
|
+
type: 'string',
|
|
2030
|
+
},
|
|
1794
2031
|
visionline_metadata: {
|
|
2032
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
1795
2033
|
properties: {
|
|
1796
2034
|
auto_join: { type: 'boolean' },
|
|
1797
2035
|
card_function_type: {
|
|
@@ -1828,7 +2066,11 @@ export default {
|
|
|
1828
2066
|
},
|
|
1829
2067
|
type: 'array',
|
|
1830
2068
|
},
|
|
1831
|
-
workspace_id: {
|
|
2069
|
+
workspace_id: {
|
|
2070
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
2071
|
+
format: 'uuid',
|
|
2072
|
+
type: 'string',
|
|
2073
|
+
},
|
|
1832
2074
|
},
|
|
1833
2075
|
required: [
|
|
1834
2076
|
'acs_credential_id',
|
|
@@ -7303,14 +7545,23 @@ export default {
|
|
|
7303
7545
|
},
|
|
7304
7546
|
'/acs/credentials/assign': {
|
|
7305
7547
|
patch: {
|
|
7548
|
+
description: 'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7306
7549
|
operationId: 'acsCredentialsAssignPatch',
|
|
7307
7550
|
requestBody: {
|
|
7308
7551
|
content: {
|
|
7309
7552
|
'application/json': {
|
|
7310
7553
|
schema: {
|
|
7311
7554
|
properties: {
|
|
7312
|
-
acs_credential_id: {
|
|
7313
|
-
|
|
7555
|
+
acs_credential_id: {
|
|
7556
|
+
description: 'ID of the desired credential.',
|
|
7557
|
+
format: 'uuid',
|
|
7558
|
+
type: 'string',
|
|
7559
|
+
},
|
|
7560
|
+
acs_user_id: {
|
|
7561
|
+
description: 'ID of the desired user.',
|
|
7562
|
+
format: 'uuid',
|
|
7563
|
+
type: 'string',
|
|
7564
|
+
},
|
|
7314
7565
|
},
|
|
7315
7566
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7316
7567
|
type: 'object',
|
|
@@ -7348,16 +7599,26 @@ export default {
|
|
|
7348
7599
|
tags: ['/acs'],
|
|
7349
7600
|
'x-fern-ignore': true,
|
|
7350
7601
|
'x-response-key': null,
|
|
7602
|
+
'x-title': 'Assign a Credential to an ACS User',
|
|
7351
7603
|
},
|
|
7352
7604
|
post: {
|
|
7605
|
+
description: 'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7353
7606
|
operationId: 'acsCredentialsAssignPost',
|
|
7354
7607
|
requestBody: {
|
|
7355
7608
|
content: {
|
|
7356
7609
|
'application/json': {
|
|
7357
7610
|
schema: {
|
|
7358
7611
|
properties: {
|
|
7359
|
-
acs_credential_id: {
|
|
7360
|
-
|
|
7612
|
+
acs_credential_id: {
|
|
7613
|
+
description: 'ID of the desired credential.',
|
|
7614
|
+
format: 'uuid',
|
|
7615
|
+
type: 'string',
|
|
7616
|
+
},
|
|
7617
|
+
acs_user_id: {
|
|
7618
|
+
description: 'ID of the desired user.',
|
|
7619
|
+
format: 'uuid',
|
|
7620
|
+
type: 'string',
|
|
7621
|
+
},
|
|
7361
7622
|
},
|
|
7362
7623
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7363
7624
|
type: 'object',
|
|
@@ -7396,10 +7657,12 @@ export default {
|
|
|
7396
7657
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
7397
7658
|
'x-fern-sdk-method-name': 'assign',
|
|
7398
7659
|
'x-response-key': null,
|
|
7660
|
+
'x-title': 'Assign a Credential to an ACS User',
|
|
7399
7661
|
},
|
|
7400
7662
|
},
|
|
7401
7663
|
'/acs/credentials/create': {
|
|
7402
7664
|
post: {
|
|
7665
|
+
description: 'Creates a new [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7403
7666
|
operationId: 'acsCredentialsCreatePost',
|
|
7404
7667
|
requestBody: {
|
|
7405
7668
|
content: {
|
|
@@ -7407,27 +7670,48 @@ export default {
|
|
|
7407
7670
|
schema: {
|
|
7408
7671
|
properties: {
|
|
7409
7672
|
access_method: {
|
|
7673
|
+
description: 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
7410
7674
|
enum: ['code', 'card', 'mobile_key'],
|
|
7411
7675
|
type: 'string',
|
|
7412
7676
|
},
|
|
7413
|
-
acs_user_id: {
|
|
7677
|
+
acs_user_id: {
|
|
7678
|
+
description: 'ID of the ACS user to whom the new credential belongs.',
|
|
7679
|
+
format: 'uuid',
|
|
7680
|
+
type: 'string',
|
|
7681
|
+
},
|
|
7414
7682
|
allowed_acs_entrance_ids: {
|
|
7415
7683
|
default: [],
|
|
7684
|
+
description: 'Set of IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access.',
|
|
7416
7685
|
items: { format: 'uuid', type: 'string' },
|
|
7417
7686
|
type: 'array',
|
|
7418
7687
|
},
|
|
7419
|
-
code: {
|
|
7688
|
+
code: {
|
|
7689
|
+
description: 'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).',
|
|
7690
|
+
pattern: '^\\d+$',
|
|
7691
|
+
type: 'string',
|
|
7692
|
+
},
|
|
7420
7693
|
credential_manager_acs_system_id: {
|
|
7694
|
+
description: 'ACS system ID of the credential manager for the new credential.',
|
|
7421
7695
|
format: 'uuid',
|
|
7422
7696
|
type: 'string',
|
|
7423
7697
|
},
|
|
7424
|
-
ends_at: {
|
|
7698
|
+
ends_at: {
|
|
7699
|
+
description: 'Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
7700
|
+
format: 'date-time',
|
|
7701
|
+
type: 'string',
|
|
7702
|
+
},
|
|
7425
7703
|
is_multi_phone_sync_credential: {
|
|
7426
7704
|
default: false,
|
|
7705
|
+
description: 'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
7427
7706
|
type: 'boolean',
|
|
7428
7707
|
},
|
|
7429
|
-
starts_at: {
|
|
7708
|
+
starts_at: {
|
|
7709
|
+
description: 'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
7710
|
+
format: 'date-time',
|
|
7711
|
+
type: 'string',
|
|
7712
|
+
},
|
|
7430
7713
|
visionline_metadata: {
|
|
7714
|
+
description: 'Visionline-specific metadata for the new credential.',
|
|
7431
7715
|
properties: {
|
|
7432
7716
|
assa_abloy_credential_service_mobile_endpoint_id: {
|
|
7433
7717
|
format: 'uuid',
|
|
@@ -7495,17 +7779,23 @@ export default {
|
|
|
7495
7779
|
'x-fern-sdk-method-name': 'create',
|
|
7496
7780
|
'x-fern-sdk-return-value': 'acs_credential',
|
|
7497
7781
|
'x-response-key': 'acs_credential',
|
|
7782
|
+
'x-title': 'Create a Credential for an ACS User',
|
|
7498
7783
|
},
|
|
7499
7784
|
},
|
|
7500
7785
|
'/acs/credentials/delete': {
|
|
7501
7786
|
post: {
|
|
7787
|
+
description: 'Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7502
7788
|
operationId: 'acsCredentialsDeletePost',
|
|
7503
7789
|
requestBody: {
|
|
7504
7790
|
content: {
|
|
7505
7791
|
'application/json': {
|
|
7506
7792
|
schema: {
|
|
7507
7793
|
properties: {
|
|
7508
|
-
acs_credential_id: {
|
|
7794
|
+
acs_credential_id: {
|
|
7795
|
+
description: 'ID of the desired credential.',
|
|
7796
|
+
format: 'uuid',
|
|
7797
|
+
type: 'string',
|
|
7798
|
+
},
|
|
7509
7799
|
},
|
|
7510
7800
|
required: ['acs_credential_id'],
|
|
7511
7801
|
type: 'object',
|
|
@@ -7539,17 +7829,23 @@ export default {
|
|
|
7539
7829
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
7540
7830
|
'x-fern-sdk-method-name': 'delete',
|
|
7541
7831
|
'x-response-key': null,
|
|
7832
|
+
'x-title': 'Delete a Credential',
|
|
7542
7833
|
},
|
|
7543
7834
|
},
|
|
7544
7835
|
'/acs/credentials/get': {
|
|
7545
7836
|
post: {
|
|
7837
|
+
description: 'Returns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7546
7838
|
operationId: 'acsCredentialsGetPost',
|
|
7547
7839
|
requestBody: {
|
|
7548
7840
|
content: {
|
|
7549
7841
|
'application/json': {
|
|
7550
7842
|
schema: {
|
|
7551
7843
|
properties: {
|
|
7552
|
-
acs_credential_id: {
|
|
7844
|
+
acs_credential_id: {
|
|
7845
|
+
description: 'ID of the desired credential.',
|
|
7846
|
+
format: 'uuid',
|
|
7847
|
+
type: 'string',
|
|
7848
|
+
},
|
|
7553
7849
|
},
|
|
7554
7850
|
required: ['acs_credential_id'],
|
|
7555
7851
|
type: 'object',
|
|
@@ -7589,10 +7885,12 @@ export default {
|
|
|
7589
7885
|
'x-fern-sdk-method-name': 'get',
|
|
7590
7886
|
'x-fern-sdk-return-value': 'acs_credential',
|
|
7591
7887
|
'x-response-key': 'acs_credential',
|
|
7888
|
+
'x-title': 'Get a Credential',
|
|
7592
7889
|
},
|
|
7593
7890
|
},
|
|
7594
7891
|
'/acs/credentials/list': {
|
|
7595
7892
|
post: {
|
|
7893
|
+
description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7596
7894
|
operationId: 'acsCredentialsListPost',
|
|
7597
7895
|
requestBody: {
|
|
7598
7896
|
content: {
|
|
@@ -7603,29 +7901,49 @@ export default {
|
|
|
7603
7901
|
oneOf: [
|
|
7604
7902
|
{
|
|
7605
7903
|
properties: {
|
|
7606
|
-
acs_user_id: {
|
|
7904
|
+
acs_user_id: {
|
|
7905
|
+
description: 'ID of the ACS user for which you want to retrieve all credentials.',
|
|
7906
|
+
format: 'uuid',
|
|
7907
|
+
type: 'string',
|
|
7908
|
+
},
|
|
7607
7909
|
},
|
|
7608
7910
|
required: ['acs_user_id'],
|
|
7609
7911
|
type: 'object',
|
|
7610
7912
|
},
|
|
7611
7913
|
{
|
|
7612
7914
|
properties: {
|
|
7613
|
-
acs_system_id: {
|
|
7915
|
+
acs_system_id: {
|
|
7916
|
+
description: 'ID of the access control system for which you want to retrieve all credentials.',
|
|
7917
|
+
format: 'uuid',
|
|
7918
|
+
type: 'string',
|
|
7919
|
+
},
|
|
7614
7920
|
},
|
|
7615
7921
|
required: ['acs_system_id'],
|
|
7616
7922
|
type: 'object',
|
|
7617
7923
|
},
|
|
7618
7924
|
{
|
|
7619
7925
|
properties: {
|
|
7620
|
-
acs_system_id: {
|
|
7621
|
-
|
|
7926
|
+
acs_system_id: {
|
|
7927
|
+
description: 'ID of the access control system for which you want to retrieve all credentials.',
|
|
7928
|
+
format: 'uuid',
|
|
7929
|
+
type: 'string',
|
|
7930
|
+
},
|
|
7931
|
+
acs_user_id: {
|
|
7932
|
+
description: 'ID of the ACS user for which you want to retrieve all credentials.',
|
|
7933
|
+
format: 'uuid',
|
|
7934
|
+
type: 'string',
|
|
7935
|
+
},
|
|
7622
7936
|
},
|
|
7623
7937
|
required: ['acs_user_id', 'acs_system_id'],
|
|
7624
7938
|
type: 'object',
|
|
7625
7939
|
},
|
|
7626
7940
|
{
|
|
7627
7941
|
properties: {
|
|
7628
|
-
user_identity_id: {
|
|
7942
|
+
user_identity_id: {
|
|
7943
|
+
description: 'ID of the user identity for which you want to retrieve all credentials.',
|
|
7944
|
+
format: 'uuid',
|
|
7945
|
+
type: 'string',
|
|
7946
|
+
},
|
|
7629
7947
|
},
|
|
7630
7948
|
required: ['user_identity_id'],
|
|
7631
7949
|
type: 'object',
|
|
@@ -7634,9 +7952,21 @@ export default {
|
|
|
7634
7952
|
},
|
|
7635
7953
|
{
|
|
7636
7954
|
properties: {
|
|
7637
|
-
created_before: {
|
|
7638
|
-
|
|
7639
|
-
|
|
7955
|
+
created_before: {
|
|
7956
|
+
description: 'Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.',
|
|
7957
|
+
format: 'date-time',
|
|
7958
|
+
type: 'string',
|
|
7959
|
+
},
|
|
7960
|
+
is_multi_phone_sync_credential: {
|
|
7961
|
+
description: 'Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.',
|
|
7962
|
+
type: 'boolean',
|
|
7963
|
+
},
|
|
7964
|
+
limit: {
|
|
7965
|
+
default: 500,
|
|
7966
|
+
description: 'Number of credentials to return.',
|
|
7967
|
+
format: 'float',
|
|
7968
|
+
type: 'number',
|
|
7969
|
+
},
|
|
7640
7970
|
},
|
|
7641
7971
|
type: 'object',
|
|
7642
7972
|
},
|
|
@@ -7679,17 +8009,23 @@ export default {
|
|
|
7679
8009
|
'x-fern-sdk-method-name': 'list',
|
|
7680
8010
|
'x-fern-sdk-return-value': 'acs_credentials',
|
|
7681
8011
|
'x-response-key': 'acs_credentials',
|
|
8012
|
+
'x-title': 'List Credentials',
|
|
7682
8013
|
},
|
|
7683
8014
|
},
|
|
7684
8015
|
'/acs/credentials/list_accessible_entrances': {
|
|
7685
8016
|
post: {
|
|
8017
|
+
description: 'Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.',
|
|
7686
8018
|
operationId: 'acsCredentialsListAccessibleEntrancesPost',
|
|
7687
8019
|
requestBody: {
|
|
7688
8020
|
content: {
|
|
7689
8021
|
'application/json': {
|
|
7690
8022
|
schema: {
|
|
7691
8023
|
properties: {
|
|
7692
|
-
acs_credential_id: {
|
|
8024
|
+
acs_credential_id: {
|
|
8025
|
+
description: 'ID of the credential for which you want to retrieve all entrances to which this credential grants access.',
|
|
8026
|
+
format: 'uuid',
|
|
8027
|
+
type: 'string',
|
|
8028
|
+
},
|
|
7693
8029
|
},
|
|
7694
8030
|
required: ['acs_credential_id'],
|
|
7695
8031
|
type: 'object',
|
|
@@ -7730,18 +8066,28 @@ export default {
|
|
|
7730
8066
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
7731
8067
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
7732
8068
|
'x-response-key': 'acs_entrances',
|
|
8069
|
+
'x-title': 'List Accessible Entrances',
|
|
7733
8070
|
},
|
|
7734
8071
|
},
|
|
7735
8072
|
'/acs/credentials/unassign': {
|
|
7736
8073
|
patch: {
|
|
8074
|
+
description: 'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7737
8075
|
operationId: 'acsCredentialsUnassignPatch',
|
|
7738
8076
|
requestBody: {
|
|
7739
8077
|
content: {
|
|
7740
8078
|
'application/json': {
|
|
7741
8079
|
schema: {
|
|
7742
8080
|
properties: {
|
|
7743
|
-
acs_credential_id: {
|
|
7744
|
-
|
|
8081
|
+
acs_credential_id: {
|
|
8082
|
+
description: 'ID of the desired credential.',
|
|
8083
|
+
format: 'uuid',
|
|
8084
|
+
type: 'string',
|
|
8085
|
+
},
|
|
8086
|
+
acs_user_id: {
|
|
8087
|
+
description: 'ID of the desired user.',
|
|
8088
|
+
format: 'uuid',
|
|
8089
|
+
type: 'string',
|
|
8090
|
+
},
|
|
7745
8091
|
},
|
|
7746
8092
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7747
8093
|
type: 'object',
|
|
@@ -7779,16 +8125,26 @@ export default {
|
|
|
7779
8125
|
tags: ['/acs'],
|
|
7780
8126
|
'x-fern-ignore': true,
|
|
7781
8127
|
'x-response-key': null,
|
|
8128
|
+
'x-title': 'Unassign a Credential from an ACS User',
|
|
7782
8129
|
},
|
|
7783
8130
|
post: {
|
|
8131
|
+
description: 'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7784
8132
|
operationId: 'acsCredentialsUnassignPost',
|
|
7785
8133
|
requestBody: {
|
|
7786
8134
|
content: {
|
|
7787
8135
|
'application/json': {
|
|
7788
8136
|
schema: {
|
|
7789
8137
|
properties: {
|
|
7790
|
-
acs_credential_id: {
|
|
7791
|
-
|
|
8138
|
+
acs_credential_id: {
|
|
8139
|
+
description: 'ID of the desired credential.',
|
|
8140
|
+
format: 'uuid',
|
|
8141
|
+
type: 'string',
|
|
8142
|
+
},
|
|
8143
|
+
acs_user_id: {
|
|
8144
|
+
description: 'ID of the desired user.',
|
|
8145
|
+
format: 'uuid',
|
|
8146
|
+
type: 'string',
|
|
8147
|
+
},
|
|
7792
8148
|
},
|
|
7793
8149
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7794
8150
|
type: 'object',
|
|
@@ -7827,17 +8183,23 @@ export default {
|
|
|
7827
8183
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
7828
8184
|
'x-fern-sdk-method-name': 'unassign',
|
|
7829
8185
|
'x-response-key': null,
|
|
8186
|
+
'x-title': 'Unassign a Credential from an ACS User',
|
|
7830
8187
|
},
|
|
7831
8188
|
},
|
|
7832
8189
|
'/acs/credentials/unmanaged/get': {
|
|
7833
8190
|
post: {
|
|
8191
|
+
description: 'Returns a specified unmanaged [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7834
8192
|
operationId: 'acsCredentialsUnmanagedGetPost',
|
|
7835
8193
|
requestBody: {
|
|
7836
8194
|
content: {
|
|
7837
8195
|
'application/json': {
|
|
7838
8196
|
schema: {
|
|
7839
8197
|
properties: {
|
|
7840
|
-
acs_credential_id: {
|
|
8198
|
+
acs_credential_id: {
|
|
8199
|
+
description: 'ID of the desired unmanaged credential.',
|
|
8200
|
+
format: 'uuid',
|
|
8201
|
+
type: 'string',
|
|
8202
|
+
},
|
|
7841
8203
|
},
|
|
7842
8204
|
required: ['acs_credential_id'],
|
|
7843
8205
|
type: 'object',
|
|
@@ -7852,23 +8214,52 @@ export default {
|
|
|
7852
8214
|
schema: {
|
|
7853
8215
|
properties: {
|
|
7854
8216
|
acs_credential: {
|
|
8217
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
7855
8218
|
properties: {
|
|
7856
8219
|
access_method: {
|
|
8220
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
7857
8221
|
enum: ['code', 'card', 'mobile_key'],
|
|
7858
8222
|
type: 'string',
|
|
7859
8223
|
},
|
|
7860
|
-
acs_credential_id: {
|
|
8224
|
+
acs_credential_id: {
|
|
8225
|
+
description: 'ID of the credential.',
|
|
8226
|
+
format: 'uuid',
|
|
8227
|
+
type: 'string',
|
|
8228
|
+
},
|
|
7861
8229
|
acs_credential_pool_id: {
|
|
7862
8230
|
format: 'uuid',
|
|
7863
8231
|
type: 'string',
|
|
7864
8232
|
},
|
|
7865
|
-
acs_system_id: {
|
|
7866
|
-
|
|
8233
|
+
acs_system_id: {
|
|
8234
|
+
description: 'ID of the access control system that contains the credential.',
|
|
8235
|
+
format: 'uuid',
|
|
8236
|
+
type: 'string',
|
|
8237
|
+
},
|
|
8238
|
+
acs_user_id: {
|
|
8239
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
8240
|
+
format: 'uuid',
|
|
8241
|
+
type: 'string',
|
|
8242
|
+
},
|
|
7867
8243
|
card_number: { nullable: true, type: 'string' },
|
|
7868
|
-
code: {
|
|
7869
|
-
|
|
7870
|
-
|
|
7871
|
-
|
|
8244
|
+
code: {
|
|
8245
|
+
description: 'Access (PIN) code for the credential.',
|
|
8246
|
+
nullable: true,
|
|
8247
|
+
type: 'string',
|
|
8248
|
+
},
|
|
8249
|
+
created_at: {
|
|
8250
|
+
description: 'Date and time at which the credential was created.',
|
|
8251
|
+
format: 'date-time',
|
|
8252
|
+
type: 'string',
|
|
8253
|
+
},
|
|
8254
|
+
display_name: {
|
|
8255
|
+
description: 'Display name that corresponds to the credential type.',
|
|
8256
|
+
minLength: 1,
|
|
8257
|
+
type: 'string',
|
|
8258
|
+
},
|
|
8259
|
+
ends_at: {
|
|
8260
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
8261
|
+
type: 'string',
|
|
8262
|
+
},
|
|
7872
8263
|
errors: {
|
|
7873
8264
|
items: {
|
|
7874
8265
|
properties: {
|
|
@@ -7881,6 +8272,7 @@ export default {
|
|
|
7881
8272
|
type: 'array',
|
|
7882
8273
|
},
|
|
7883
8274
|
external_type: {
|
|
8275
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
7884
8276
|
enum: [
|
|
7885
8277
|
'pti_card',
|
|
7886
8278
|
'brivo_credential',
|
|
@@ -7890,28 +8282,41 @@ export default {
|
|
|
7890
8282
|
],
|
|
7891
8283
|
type: 'string',
|
|
7892
8284
|
},
|
|
7893
|
-
external_type_display_name: {
|
|
8285
|
+
external_type_display_name: {
|
|
8286
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
8287
|
+
type: 'string',
|
|
8288
|
+
},
|
|
7894
8289
|
is_issued: { type: 'boolean' },
|
|
7895
8290
|
is_latest_desired_state_synced_with_provider: {
|
|
8291
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
7896
8292
|
type: 'boolean',
|
|
7897
8293
|
},
|
|
7898
8294
|
is_managed: { enum: [false], type: 'boolean' },
|
|
7899
|
-
is_multi_phone_sync_credential: {
|
|
8295
|
+
is_multi_phone_sync_credential: {
|
|
8296
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
8297
|
+
type: 'boolean',
|
|
8298
|
+
},
|
|
7900
8299
|
issued_at: {
|
|
7901
8300
|
format: 'date-time',
|
|
7902
8301
|
nullable: true,
|
|
7903
8302
|
type: 'string',
|
|
7904
8303
|
},
|
|
7905
8304
|
latest_desired_state_synced_with_provider_at: {
|
|
8305
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
7906
8306
|
format: 'date-time',
|
|
7907
8307
|
type: 'string',
|
|
7908
8308
|
},
|
|
7909
8309
|
parent_acs_credential_id: {
|
|
8310
|
+
description: 'ID of the parent credential.',
|
|
7910
8311
|
format: 'uuid',
|
|
7911
8312
|
type: 'string',
|
|
7912
8313
|
},
|
|
7913
|
-
starts_at: {
|
|
8314
|
+
starts_at: {
|
|
8315
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
8316
|
+
type: 'string',
|
|
8317
|
+
},
|
|
7914
8318
|
visionline_metadata: {
|
|
8319
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
7915
8320
|
properties: {
|
|
7916
8321
|
auto_join: { type: 'boolean' },
|
|
7917
8322
|
card_function_type: {
|
|
@@ -7948,7 +8353,11 @@ export default {
|
|
|
7948
8353
|
},
|
|
7949
8354
|
type: 'array',
|
|
7950
8355
|
},
|
|
7951
|
-
workspace_id: {
|
|
8356
|
+
workspace_id: {
|
|
8357
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
8358
|
+
format: 'uuid',
|
|
8359
|
+
type: 'string',
|
|
8360
|
+
},
|
|
7952
8361
|
},
|
|
7953
8362
|
required: [
|
|
7954
8363
|
'acs_credential_id',
|
|
@@ -7986,10 +8395,12 @@ export default {
|
|
|
7986
8395
|
'x-fern-sdk-method-name': 'get',
|
|
7987
8396
|
'x-fern-sdk-return-value': 'acs_credential',
|
|
7988
8397
|
'x-response-key': 'acs_credential',
|
|
8398
|
+
'x-title': 'Get an Unmanaged Credential',
|
|
7989
8399
|
},
|
|
7990
8400
|
},
|
|
7991
8401
|
'/acs/credentials/unmanaged/list': {
|
|
7992
8402
|
post: {
|
|
8403
|
+
description: 'Returns a list of all unmanaged [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7993
8404
|
operationId: 'acsCredentialsUnmanagedListPost',
|
|
7994
8405
|
requestBody: {
|
|
7995
8406
|
content: {
|
|
@@ -7998,29 +8409,49 @@ export default {
|
|
|
7998
8409
|
oneOf: [
|
|
7999
8410
|
{
|
|
8000
8411
|
properties: {
|
|
8001
|
-
acs_user_id: {
|
|
8412
|
+
acs_user_id: {
|
|
8413
|
+
description: 'ID of the ACS user for which you want to retrieve all credentials.',
|
|
8414
|
+
format: 'uuid',
|
|
8415
|
+
type: 'string',
|
|
8416
|
+
},
|
|
8002
8417
|
},
|
|
8003
8418
|
required: ['acs_user_id'],
|
|
8004
8419
|
type: 'object',
|
|
8005
8420
|
},
|
|
8006
8421
|
{
|
|
8007
8422
|
properties: {
|
|
8008
|
-
acs_system_id: {
|
|
8423
|
+
acs_system_id: {
|
|
8424
|
+
description: 'ID of the access control system for which you want to retrieve all credentials.',
|
|
8425
|
+
format: 'uuid',
|
|
8426
|
+
type: 'string',
|
|
8427
|
+
},
|
|
8009
8428
|
},
|
|
8010
8429
|
required: ['acs_system_id'],
|
|
8011
8430
|
type: 'object',
|
|
8012
8431
|
},
|
|
8013
8432
|
{
|
|
8014
8433
|
properties: {
|
|
8015
|
-
acs_system_id: {
|
|
8016
|
-
|
|
8434
|
+
acs_system_id: {
|
|
8435
|
+
description: 'ID of the access control system for which you want to retrieve all credentials.',
|
|
8436
|
+
format: 'uuid',
|
|
8437
|
+
type: 'string',
|
|
8438
|
+
},
|
|
8439
|
+
acs_user_id: {
|
|
8440
|
+
description: 'ID of the ACS user for which you want to retrieve all credentials.',
|
|
8441
|
+
format: 'uuid',
|
|
8442
|
+
type: 'string',
|
|
8443
|
+
},
|
|
8017
8444
|
},
|
|
8018
8445
|
required: ['acs_user_id', 'acs_system_id'],
|
|
8019
8446
|
type: 'object',
|
|
8020
8447
|
},
|
|
8021
8448
|
{
|
|
8022
8449
|
properties: {
|
|
8023
|
-
user_identity_id: {
|
|
8450
|
+
user_identity_id: {
|
|
8451
|
+
description: 'ID of the user identity for which you want to retrieve all credentials.',
|
|
8452
|
+
format: 'uuid',
|
|
8453
|
+
type: 'string',
|
|
8454
|
+
},
|
|
8024
8455
|
},
|
|
8025
8456
|
required: ['user_identity_id'],
|
|
8026
8457
|
type: 'object',
|
|
@@ -8038,23 +8469,52 @@ export default {
|
|
|
8038
8469
|
properties: {
|
|
8039
8470
|
acs_credentials: {
|
|
8040
8471
|
items: {
|
|
8472
|
+
description: 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
8041
8473
|
properties: {
|
|
8042
8474
|
access_method: {
|
|
8475
|
+
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
8043
8476
|
enum: ['code', 'card', 'mobile_key'],
|
|
8044
8477
|
type: 'string',
|
|
8045
8478
|
},
|
|
8046
|
-
acs_credential_id: {
|
|
8479
|
+
acs_credential_id: {
|
|
8480
|
+
description: 'ID of the credential.',
|
|
8481
|
+
format: 'uuid',
|
|
8482
|
+
type: 'string',
|
|
8483
|
+
},
|
|
8047
8484
|
acs_credential_pool_id: {
|
|
8048
8485
|
format: 'uuid',
|
|
8049
8486
|
type: 'string',
|
|
8050
8487
|
},
|
|
8051
|
-
acs_system_id: {
|
|
8052
|
-
|
|
8488
|
+
acs_system_id: {
|
|
8489
|
+
description: 'ID of the access control system that contains the credential.',
|
|
8490
|
+
format: 'uuid',
|
|
8491
|
+
type: 'string',
|
|
8492
|
+
},
|
|
8493
|
+
acs_user_id: {
|
|
8494
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
8495
|
+
format: 'uuid',
|
|
8496
|
+
type: 'string',
|
|
8497
|
+
},
|
|
8053
8498
|
card_number: { nullable: true, type: 'string' },
|
|
8054
|
-
code: {
|
|
8055
|
-
|
|
8056
|
-
|
|
8057
|
-
|
|
8499
|
+
code: {
|
|
8500
|
+
description: 'Access (PIN) code for the credential.',
|
|
8501
|
+
nullable: true,
|
|
8502
|
+
type: 'string',
|
|
8503
|
+
},
|
|
8504
|
+
created_at: {
|
|
8505
|
+
description: 'Date and time at which the credential was created.',
|
|
8506
|
+
format: 'date-time',
|
|
8507
|
+
type: 'string',
|
|
8508
|
+
},
|
|
8509
|
+
display_name: {
|
|
8510
|
+
description: 'Display name that corresponds to the credential type.',
|
|
8511
|
+
minLength: 1,
|
|
8512
|
+
type: 'string',
|
|
8513
|
+
},
|
|
8514
|
+
ends_at: {
|
|
8515
|
+
description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
8516
|
+
type: 'string',
|
|
8517
|
+
},
|
|
8058
8518
|
errors: {
|
|
8059
8519
|
items: {
|
|
8060
8520
|
properties: {
|
|
@@ -8067,6 +8527,7 @@ export default {
|
|
|
8067
8527
|
type: 'array',
|
|
8068
8528
|
},
|
|
8069
8529
|
external_type: {
|
|
8530
|
+
description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
8070
8531
|
enum: [
|
|
8071
8532
|
'pti_card',
|
|
8072
8533
|
'brivo_credential',
|
|
@@ -8076,28 +8537,41 @@ export default {
|
|
|
8076
8537
|
],
|
|
8077
8538
|
type: 'string',
|
|
8078
8539
|
},
|
|
8079
|
-
external_type_display_name: {
|
|
8540
|
+
external_type_display_name: {
|
|
8541
|
+
description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
8542
|
+
type: 'string',
|
|
8543
|
+
},
|
|
8080
8544
|
is_issued: { type: 'boolean' },
|
|
8081
8545
|
is_latest_desired_state_synced_with_provider: {
|
|
8546
|
+
description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
8082
8547
|
type: 'boolean',
|
|
8083
8548
|
},
|
|
8084
8549
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8085
|
-
is_multi_phone_sync_credential: {
|
|
8550
|
+
is_multi_phone_sync_credential: {
|
|
8551
|
+
description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
8552
|
+
type: 'boolean',
|
|
8553
|
+
},
|
|
8086
8554
|
issued_at: {
|
|
8087
8555
|
format: 'date-time',
|
|
8088
8556
|
nullable: true,
|
|
8089
8557
|
type: 'string',
|
|
8090
8558
|
},
|
|
8091
8559
|
latest_desired_state_synced_with_provider_at: {
|
|
8560
|
+
description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
8092
8561
|
format: 'date-time',
|
|
8093
8562
|
type: 'string',
|
|
8094
8563
|
},
|
|
8095
8564
|
parent_acs_credential_id: {
|
|
8565
|
+
description: 'ID of the parent credential.',
|
|
8096
8566
|
format: 'uuid',
|
|
8097
8567
|
type: 'string',
|
|
8098
8568
|
},
|
|
8099
|
-
starts_at: {
|
|
8569
|
+
starts_at: {
|
|
8570
|
+
description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
8571
|
+
type: 'string',
|
|
8572
|
+
},
|
|
8100
8573
|
visionline_metadata: {
|
|
8574
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
8101
8575
|
properties: {
|
|
8102
8576
|
auto_join: { type: 'boolean' },
|
|
8103
8577
|
card_function_type: {
|
|
@@ -8134,7 +8608,11 @@ export default {
|
|
|
8134
8608
|
},
|
|
8135
8609
|
type: 'array',
|
|
8136
8610
|
},
|
|
8137
|
-
workspace_id: {
|
|
8611
|
+
workspace_id: {
|
|
8612
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
8613
|
+
format: 'uuid',
|
|
8614
|
+
type: 'string',
|
|
8615
|
+
},
|
|
8138
8616
|
},
|
|
8139
8617
|
required: [
|
|
8140
8618
|
'acs_credential_id',
|
|
@@ -8174,19 +8652,32 @@ export default {
|
|
|
8174
8652
|
'x-fern-sdk-method-name': 'list',
|
|
8175
8653
|
'x-fern-sdk-return-value': 'acs_credentials',
|
|
8176
8654
|
'x-response-key': 'acs_credentials',
|
|
8655
|
+
'x-title': 'List Unmanaged Credentials',
|
|
8177
8656
|
},
|
|
8178
8657
|
},
|
|
8179
8658
|
'/acs/credentials/update': {
|
|
8180
8659
|
patch: {
|
|
8660
|
+
description: 'Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
8181
8661
|
operationId: 'acsCredentialsUpdatePatch',
|
|
8182
8662
|
requestBody: {
|
|
8183
8663
|
content: {
|
|
8184
8664
|
'application/json': {
|
|
8185
8665
|
schema: {
|
|
8186
8666
|
properties: {
|
|
8187
|
-
acs_credential_id: {
|
|
8188
|
-
|
|
8189
|
-
|
|
8667
|
+
acs_credential_id: {
|
|
8668
|
+
description: 'ID of the desired credential.',
|
|
8669
|
+
type: 'string',
|
|
8670
|
+
},
|
|
8671
|
+
code: {
|
|
8672
|
+
description: 'Replacement access (PIN) code for the credential.',
|
|
8673
|
+
pattern: '^\\d+$',
|
|
8674
|
+
type: 'string',
|
|
8675
|
+
},
|
|
8676
|
+
ends_at: {
|
|
8677
|
+
description: 'Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.',
|
|
8678
|
+
format: 'date-time',
|
|
8679
|
+
type: 'string',
|
|
8680
|
+
},
|
|
8190
8681
|
},
|
|
8191
8682
|
required: ['acs_credential_id'],
|
|
8192
8683
|
type: 'object',
|
|
@@ -8224,17 +8715,30 @@ export default {
|
|
|
8224
8715
|
tags: ['/acs'],
|
|
8225
8716
|
'x-fern-ignore': true,
|
|
8226
8717
|
'x-response-key': null,
|
|
8718
|
+
'x-title': 'Update a Credential',
|
|
8227
8719
|
},
|
|
8228
8720
|
post: {
|
|
8721
|
+
description: 'Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
8229
8722
|
operationId: 'acsCredentialsUpdatePost',
|
|
8230
8723
|
requestBody: {
|
|
8231
8724
|
content: {
|
|
8232
8725
|
'application/json': {
|
|
8233
8726
|
schema: {
|
|
8234
8727
|
properties: {
|
|
8235
|
-
acs_credential_id: {
|
|
8236
|
-
|
|
8237
|
-
|
|
8728
|
+
acs_credential_id: {
|
|
8729
|
+
description: 'ID of the desired credential.',
|
|
8730
|
+
type: 'string',
|
|
8731
|
+
},
|
|
8732
|
+
code: {
|
|
8733
|
+
description: 'Replacement access (PIN) code for the credential.',
|
|
8734
|
+
pattern: '^\\d+$',
|
|
8735
|
+
type: 'string',
|
|
8736
|
+
},
|
|
8737
|
+
ends_at: {
|
|
8738
|
+
description: 'Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.',
|
|
8739
|
+
format: 'date-time',
|
|
8740
|
+
type: 'string',
|
|
8741
|
+
},
|
|
8238
8742
|
},
|
|
8239
8743
|
required: ['acs_credential_id'],
|
|
8240
8744
|
type: 'object',
|
|
@@ -8273,6 +8777,7 @@ export default {
|
|
|
8273
8777
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
8274
8778
|
'x-fern-sdk-method-name': 'update',
|
|
8275
8779
|
'x-response-key': null,
|
|
8780
|
+
'x-title': 'Update a Credential',
|
|
8276
8781
|
},
|
|
8277
8782
|
},
|
|
8278
8783
|
'/acs/encoders/encode_card': {
|