@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
|
@@ -263,20 +263,54 @@ export default {
|
|
|
263
263
|
type: 'object',
|
|
264
264
|
},
|
|
265
265
|
acs_credential: {
|
|
266
|
+
description:
|
|
267
|
+
'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.',
|
|
266
268
|
properties: {
|
|
267
269
|
access_method: {
|
|
270
|
+
description:
|
|
271
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
268
272
|
enum: ['code', 'card', 'mobile_key'],
|
|
269
273
|
type: 'string',
|
|
270
274
|
},
|
|
271
|
-
acs_credential_id: {
|
|
275
|
+
acs_credential_id: {
|
|
276
|
+
description: 'ID of the credential.',
|
|
277
|
+
format: 'uuid',
|
|
278
|
+
type: 'string',
|
|
279
|
+
},
|
|
272
280
|
acs_credential_pool_id: { format: 'uuid', type: 'string' },
|
|
273
|
-
acs_system_id: {
|
|
274
|
-
|
|
281
|
+
acs_system_id: {
|
|
282
|
+
description:
|
|
283
|
+
'ID of the access control system that contains the credential.',
|
|
284
|
+
format: 'uuid',
|
|
285
|
+
type: 'string',
|
|
286
|
+
},
|
|
287
|
+
acs_user_id: {
|
|
288
|
+
description: 'ID of the ACS user to whom the credential belongs.',
|
|
289
|
+
format: 'uuid',
|
|
290
|
+
type: 'string',
|
|
291
|
+
},
|
|
275
292
|
card_number: { nullable: true, type: 'string' },
|
|
276
|
-
code: {
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
293
|
+
code: {
|
|
294
|
+
description: 'Access (PIN) code for the credential.',
|
|
295
|
+
nullable: true,
|
|
296
|
+
type: 'string',
|
|
297
|
+
},
|
|
298
|
+
created_at: {
|
|
299
|
+
description: 'Date and time at which the credential was created.',
|
|
300
|
+
format: 'date-time',
|
|
301
|
+
type: 'string',
|
|
302
|
+
},
|
|
303
|
+
display_name: {
|
|
304
|
+
description:
|
|
305
|
+
'Display name that corresponds to the credential type.',
|
|
306
|
+
minLength: 1,
|
|
307
|
+
type: 'string',
|
|
308
|
+
},
|
|
309
|
+
ends_at: {
|
|
310
|
+
description:
|
|
311
|
+
'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`.',
|
|
312
|
+
type: 'string',
|
|
313
|
+
},
|
|
280
314
|
errors: {
|
|
281
315
|
items: {
|
|
282
316
|
properties: {
|
|
@@ -289,6 +323,8 @@ export default {
|
|
|
289
323
|
type: 'array',
|
|
290
324
|
},
|
|
291
325
|
external_type: {
|
|
326
|
+
description:
|
|
327
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
292
328
|
enum: [
|
|
293
329
|
'pti_card',
|
|
294
330
|
'brivo_credential',
|
|
@@ -298,19 +334,42 @@ export default {
|
|
|
298
334
|
],
|
|
299
335
|
type: 'string',
|
|
300
336
|
},
|
|
301
|
-
external_type_display_name: {
|
|
337
|
+
external_type_display_name: {
|
|
338
|
+
description:
|
|
339
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
340
|
+
type: 'string',
|
|
341
|
+
},
|
|
302
342
|
is_issued: { type: 'boolean' },
|
|
303
|
-
is_latest_desired_state_synced_with_provider: {
|
|
343
|
+
is_latest_desired_state_synced_with_provider: {
|
|
344
|
+
description:
|
|
345
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
346
|
+
type: 'boolean',
|
|
347
|
+
},
|
|
304
348
|
is_managed: { enum: [true], type: 'boolean' },
|
|
305
|
-
is_multi_phone_sync_credential: {
|
|
349
|
+
is_multi_phone_sync_credential: {
|
|
350
|
+
description:
|
|
351
|
+
'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).',
|
|
352
|
+
type: 'boolean',
|
|
353
|
+
},
|
|
306
354
|
issued_at: { format: 'date-time', nullable: true, type: 'string' },
|
|
307
355
|
latest_desired_state_synced_with_provider_at: {
|
|
356
|
+
description:
|
|
357
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
308
358
|
format: 'date-time',
|
|
309
359
|
type: 'string',
|
|
310
360
|
},
|
|
311
|
-
parent_acs_credential_id: {
|
|
312
|
-
|
|
361
|
+
parent_acs_credential_id: {
|
|
362
|
+
description: 'ID of the parent credential.',
|
|
363
|
+
format: 'uuid',
|
|
364
|
+
type: 'string',
|
|
365
|
+
},
|
|
366
|
+
starts_at: {
|
|
367
|
+
description:
|
|
368
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
369
|
+
type: 'string',
|
|
370
|
+
},
|
|
313
371
|
visionline_metadata: {
|
|
372
|
+
description: 'Visionline-specific metadata for the credential.',
|
|
314
373
|
properties: {
|
|
315
374
|
auto_join: { type: 'boolean' },
|
|
316
375
|
card_function_type: { enum: ['guest', 'staff'], type: 'string' },
|
|
@@ -344,7 +403,12 @@ export default {
|
|
|
344
403
|
},
|
|
345
404
|
type: 'array',
|
|
346
405
|
},
|
|
347
|
-
workspace_id: {
|
|
406
|
+
workspace_id: {
|
|
407
|
+
description:
|
|
408
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
409
|
+
format: 'uuid',
|
|
410
|
+
type: 'string',
|
|
411
|
+
},
|
|
348
412
|
},
|
|
349
413
|
required: [
|
|
350
414
|
'acs_credential_id',
|
|
@@ -1331,6 +1395,8 @@ export default {
|
|
|
1331
1395
|
type: 'string',
|
|
1332
1396
|
},
|
|
1333
1397
|
visionline_metadata: {
|
|
1398
|
+
description:
|
|
1399
|
+
'Visionline-specific metadata for the credential.',
|
|
1334
1400
|
properties: {
|
|
1335
1401
|
cancelled: { type: 'boolean' },
|
|
1336
1402
|
card_format: {
|
|
@@ -1385,23 +1451,60 @@ export default {
|
|
|
1385
1451
|
nullable: true,
|
|
1386
1452
|
oneOf: [
|
|
1387
1453
|
{
|
|
1454
|
+
description:
|
|
1455
|
+
'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.',
|
|
1388
1456
|
properties: {
|
|
1389
1457
|
access_method: {
|
|
1458
|
+
description:
|
|
1459
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1390
1460
|
enum: ['code', 'card', 'mobile_key'],
|
|
1391
1461
|
type: 'string',
|
|
1392
1462
|
},
|
|
1393
|
-
acs_credential_id: {
|
|
1463
|
+
acs_credential_id: {
|
|
1464
|
+
description: 'ID of the credential.',
|
|
1465
|
+
format: 'uuid',
|
|
1466
|
+
type: 'string',
|
|
1467
|
+
},
|
|
1394
1468
|
acs_credential_pool_id: {
|
|
1395
1469
|
format: 'uuid',
|
|
1396
1470
|
type: 'string',
|
|
1397
1471
|
},
|
|
1398
|
-
acs_system_id: {
|
|
1399
|
-
|
|
1472
|
+
acs_system_id: {
|
|
1473
|
+
description:
|
|
1474
|
+
'ID of the access control system that contains the credential.',
|
|
1475
|
+
format: 'uuid',
|
|
1476
|
+
type: 'string',
|
|
1477
|
+
},
|
|
1478
|
+
acs_user_id: {
|
|
1479
|
+
description:
|
|
1480
|
+
'ID of the ACS user to whom the credential belongs.',
|
|
1481
|
+
format: 'uuid',
|
|
1482
|
+
type: 'string',
|
|
1483
|
+
},
|
|
1400
1484
|
card_number: { nullable: true, type: 'string' },
|
|
1401
|
-
code: {
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1485
|
+
code: {
|
|
1486
|
+
description:
|
|
1487
|
+
'Access (PIN) code for the credential.',
|
|
1488
|
+
nullable: true,
|
|
1489
|
+
type: 'string',
|
|
1490
|
+
},
|
|
1491
|
+
created_at: {
|
|
1492
|
+
description:
|
|
1493
|
+
'Date and time at which the credential was created.',
|
|
1494
|
+
format: 'date-time',
|
|
1495
|
+
type: 'string',
|
|
1496
|
+
},
|
|
1497
|
+
display_name: {
|
|
1498
|
+
description:
|
|
1499
|
+
'Display name that corresponds to the credential type.',
|
|
1500
|
+
minLength: 1,
|
|
1501
|
+
type: 'string',
|
|
1502
|
+
},
|
|
1503
|
+
ends_at: {
|
|
1504
|
+
description:
|
|
1505
|
+
'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`.',
|
|
1506
|
+
type: 'string',
|
|
1507
|
+
},
|
|
1405
1508
|
errors: {
|
|
1406
1509
|
items: {
|
|
1407
1510
|
properties: {
|
|
@@ -1414,6 +1517,8 @@ export default {
|
|
|
1414
1517
|
type: 'array',
|
|
1415
1518
|
},
|
|
1416
1519
|
external_type: {
|
|
1520
|
+
description:
|
|
1521
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1417
1522
|
enum: [
|
|
1418
1523
|
'pti_card',
|
|
1419
1524
|
'brivo_credential',
|
|
@@ -1423,28 +1528,47 @@ export default {
|
|
|
1423
1528
|
],
|
|
1424
1529
|
type: 'string',
|
|
1425
1530
|
},
|
|
1426
|
-
external_type_display_name: {
|
|
1531
|
+
external_type_display_name: {
|
|
1532
|
+
description:
|
|
1533
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1534
|
+
type: 'string',
|
|
1535
|
+
},
|
|
1427
1536
|
is_issued: { type: 'boolean' },
|
|
1428
1537
|
is_latest_desired_state_synced_with_provider: {
|
|
1538
|
+
description:
|
|
1539
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1429
1540
|
type: 'boolean',
|
|
1430
1541
|
},
|
|
1431
1542
|
is_managed: { enum: [true], type: 'boolean' },
|
|
1432
|
-
is_multi_phone_sync_credential: {
|
|
1543
|
+
is_multi_phone_sync_credential: {
|
|
1544
|
+
description:
|
|
1545
|
+
'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).',
|
|
1546
|
+
type: 'boolean',
|
|
1547
|
+
},
|
|
1433
1548
|
issued_at: {
|
|
1434
1549
|
format: 'date-time',
|
|
1435
1550
|
nullable: true,
|
|
1436
1551
|
type: 'string',
|
|
1437
1552
|
},
|
|
1438
1553
|
latest_desired_state_synced_with_provider_at: {
|
|
1554
|
+
description:
|
|
1555
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1439
1556
|
format: 'date-time',
|
|
1440
1557
|
type: 'string',
|
|
1441
1558
|
},
|
|
1442
1559
|
parent_acs_credential_id: {
|
|
1560
|
+
description: 'ID of the parent credential.',
|
|
1443
1561
|
format: 'uuid',
|
|
1444
1562
|
type: 'string',
|
|
1445
1563
|
},
|
|
1446
|
-
starts_at: {
|
|
1564
|
+
starts_at: {
|
|
1565
|
+
description:
|
|
1566
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
1567
|
+
type: 'string',
|
|
1568
|
+
},
|
|
1447
1569
|
visionline_metadata: {
|
|
1570
|
+
description:
|
|
1571
|
+
'Visionline-specific metadata for the credential.',
|
|
1448
1572
|
properties: {
|
|
1449
1573
|
auto_join: { type: 'boolean' },
|
|
1450
1574
|
card_function_type: {
|
|
@@ -1481,7 +1605,12 @@ export default {
|
|
|
1481
1605
|
},
|
|
1482
1606
|
type: 'array',
|
|
1483
1607
|
},
|
|
1484
|
-
workspace_id: {
|
|
1608
|
+
workspace_id: {
|
|
1609
|
+
description:
|
|
1610
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
1611
|
+
format: 'uuid',
|
|
1612
|
+
type: 'string',
|
|
1613
|
+
},
|
|
1485
1614
|
},
|
|
1486
1615
|
required: [
|
|
1487
1616
|
'acs_credential_id',
|
|
@@ -1497,23 +1626,60 @@ export default {
|
|
|
1497
1626
|
type: 'object',
|
|
1498
1627
|
},
|
|
1499
1628
|
{
|
|
1629
|
+
description:
|
|
1630
|
+
'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.',
|
|
1500
1631
|
properties: {
|
|
1501
1632
|
access_method: {
|
|
1633
|
+
description:
|
|
1634
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1502
1635
|
enum: ['code', 'card', 'mobile_key'],
|
|
1503
1636
|
type: 'string',
|
|
1504
1637
|
},
|
|
1505
|
-
acs_credential_id: {
|
|
1638
|
+
acs_credential_id: {
|
|
1639
|
+
description: 'ID of the credential.',
|
|
1640
|
+
format: 'uuid',
|
|
1641
|
+
type: 'string',
|
|
1642
|
+
},
|
|
1506
1643
|
acs_credential_pool_id: {
|
|
1507
1644
|
format: 'uuid',
|
|
1508
1645
|
type: 'string',
|
|
1509
1646
|
},
|
|
1510
|
-
acs_system_id: {
|
|
1511
|
-
|
|
1647
|
+
acs_system_id: {
|
|
1648
|
+
description:
|
|
1649
|
+
'ID of the access control system that contains the credential.',
|
|
1650
|
+
format: 'uuid',
|
|
1651
|
+
type: 'string',
|
|
1652
|
+
},
|
|
1653
|
+
acs_user_id: {
|
|
1654
|
+
description:
|
|
1655
|
+
'ID of the ACS user to whom the credential belongs.',
|
|
1656
|
+
format: 'uuid',
|
|
1657
|
+
type: 'string',
|
|
1658
|
+
},
|
|
1512
1659
|
card_number: { nullable: true, type: 'string' },
|
|
1513
|
-
code: {
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1660
|
+
code: {
|
|
1661
|
+
description:
|
|
1662
|
+
'Access (PIN) code for the credential.',
|
|
1663
|
+
nullable: true,
|
|
1664
|
+
type: 'string',
|
|
1665
|
+
},
|
|
1666
|
+
created_at: {
|
|
1667
|
+
description:
|
|
1668
|
+
'Date and time at which the credential was created.',
|
|
1669
|
+
format: 'date-time',
|
|
1670
|
+
type: 'string',
|
|
1671
|
+
},
|
|
1672
|
+
display_name: {
|
|
1673
|
+
description:
|
|
1674
|
+
'Display name that corresponds to the credential type.',
|
|
1675
|
+
minLength: 1,
|
|
1676
|
+
type: 'string',
|
|
1677
|
+
},
|
|
1678
|
+
ends_at: {
|
|
1679
|
+
description:
|
|
1680
|
+
'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`.',
|
|
1681
|
+
type: 'string',
|
|
1682
|
+
},
|
|
1517
1683
|
errors: {
|
|
1518
1684
|
items: {
|
|
1519
1685
|
properties: {
|
|
@@ -1526,6 +1692,8 @@ export default {
|
|
|
1526
1692
|
type: 'array',
|
|
1527
1693
|
},
|
|
1528
1694
|
external_type: {
|
|
1695
|
+
description:
|
|
1696
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1529
1697
|
enum: [
|
|
1530
1698
|
'pti_card',
|
|
1531
1699
|
'brivo_credential',
|
|
@@ -1535,28 +1703,47 @@ export default {
|
|
|
1535
1703
|
],
|
|
1536
1704
|
type: 'string',
|
|
1537
1705
|
},
|
|
1538
|
-
external_type_display_name: {
|
|
1706
|
+
external_type_display_name: {
|
|
1707
|
+
description:
|
|
1708
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1709
|
+
type: 'string',
|
|
1710
|
+
},
|
|
1539
1711
|
is_issued: { type: 'boolean' },
|
|
1540
1712
|
is_latest_desired_state_synced_with_provider: {
|
|
1713
|
+
description:
|
|
1714
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1541
1715
|
type: 'boolean',
|
|
1542
1716
|
},
|
|
1543
1717
|
is_managed: { enum: [false], type: 'boolean' },
|
|
1544
|
-
is_multi_phone_sync_credential: {
|
|
1718
|
+
is_multi_phone_sync_credential: {
|
|
1719
|
+
description:
|
|
1720
|
+
'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).',
|
|
1721
|
+
type: 'boolean',
|
|
1722
|
+
},
|
|
1545
1723
|
issued_at: {
|
|
1546
1724
|
format: 'date-time',
|
|
1547
1725
|
nullable: true,
|
|
1548
1726
|
type: 'string',
|
|
1549
1727
|
},
|
|
1550
1728
|
latest_desired_state_synced_with_provider_at: {
|
|
1729
|
+
description:
|
|
1730
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1551
1731
|
format: 'date-time',
|
|
1552
1732
|
type: 'string',
|
|
1553
1733
|
},
|
|
1554
1734
|
parent_acs_credential_id: {
|
|
1735
|
+
description: 'ID of the parent credential.',
|
|
1555
1736
|
format: 'uuid',
|
|
1556
1737
|
type: 'string',
|
|
1557
1738
|
},
|
|
1558
|
-
starts_at: {
|
|
1739
|
+
starts_at: {
|
|
1740
|
+
description:
|
|
1741
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
1742
|
+
type: 'string',
|
|
1743
|
+
},
|
|
1559
1744
|
visionline_metadata: {
|
|
1745
|
+
description:
|
|
1746
|
+
'Visionline-specific metadata for the credential.',
|
|
1560
1747
|
properties: {
|
|
1561
1748
|
auto_join: { type: 'boolean' },
|
|
1562
1749
|
card_function_type: {
|
|
@@ -1593,7 +1780,12 @@ export default {
|
|
|
1593
1780
|
},
|
|
1594
1781
|
type: 'array',
|
|
1595
1782
|
},
|
|
1596
|
-
workspace_id: {
|
|
1783
|
+
workspace_id: {
|
|
1784
|
+
description:
|
|
1785
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
1786
|
+
format: 'uuid',
|
|
1787
|
+
type: 'string',
|
|
1788
|
+
},
|
|
1597
1789
|
},
|
|
1598
1790
|
required: [
|
|
1599
1791
|
'acs_credential_id',
|
|
@@ -1708,25 +1900,63 @@ export default {
|
|
|
1708
1900
|
action_type: { enum: ['ENCODE_CARD'], type: 'string' },
|
|
1709
1901
|
error: { nullable: true },
|
|
1710
1902
|
result: {
|
|
1903
|
+
description:
|
|
1904
|
+
'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.',
|
|
1711
1905
|
oneOf: [
|
|
1712
1906
|
{
|
|
1907
|
+
description:
|
|
1908
|
+
'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.',
|
|
1713
1909
|
properties: {
|
|
1714
1910
|
access_method: {
|
|
1911
|
+
description:
|
|
1912
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1715
1913
|
enum: ['code', 'card', 'mobile_key'],
|
|
1716
1914
|
type: 'string',
|
|
1717
1915
|
},
|
|
1718
|
-
acs_credential_id: {
|
|
1916
|
+
acs_credential_id: {
|
|
1917
|
+
description: 'ID of the credential.',
|
|
1918
|
+
format: 'uuid',
|
|
1919
|
+
type: 'string',
|
|
1920
|
+
},
|
|
1719
1921
|
acs_credential_pool_id: {
|
|
1720
1922
|
format: 'uuid',
|
|
1721
1923
|
type: 'string',
|
|
1722
1924
|
},
|
|
1723
|
-
acs_system_id: {
|
|
1724
|
-
|
|
1925
|
+
acs_system_id: {
|
|
1926
|
+
description:
|
|
1927
|
+
'ID of the access control system that contains the credential.',
|
|
1928
|
+
format: 'uuid',
|
|
1929
|
+
type: 'string',
|
|
1930
|
+
},
|
|
1931
|
+
acs_user_id: {
|
|
1932
|
+
description:
|
|
1933
|
+
'ID of the ACS user to whom the credential belongs.',
|
|
1934
|
+
format: 'uuid',
|
|
1935
|
+
type: 'string',
|
|
1936
|
+
},
|
|
1725
1937
|
card_number: { nullable: true, type: 'string' },
|
|
1726
|
-
code: {
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1938
|
+
code: {
|
|
1939
|
+
description: 'Access (PIN) code for the credential.',
|
|
1940
|
+
nullable: true,
|
|
1941
|
+
type: 'string',
|
|
1942
|
+
},
|
|
1943
|
+
created_at: {
|
|
1944
|
+
description:
|
|
1945
|
+
'Date and time at which the credential was created.',
|
|
1946
|
+
format: 'date-time',
|
|
1947
|
+
type: 'string',
|
|
1948
|
+
},
|
|
1949
|
+
display_name: {
|
|
1950
|
+
description:
|
|
1951
|
+
'Display name that corresponds to the credential type.',
|
|
1952
|
+
minLength: 1,
|
|
1953
|
+
type: 'string',
|
|
1954
|
+
},
|
|
1955
|
+
ends_at: {
|
|
1956
|
+
description:
|
|
1957
|
+
'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`.',
|
|
1958
|
+
type: 'string',
|
|
1959
|
+
},
|
|
1730
1960
|
errors: {
|
|
1731
1961
|
items: {
|
|
1732
1962
|
properties: {
|
|
@@ -1739,6 +1969,8 @@ export default {
|
|
|
1739
1969
|
type: 'array',
|
|
1740
1970
|
},
|
|
1741
1971
|
external_type: {
|
|
1972
|
+
description:
|
|
1973
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1742
1974
|
enum: [
|
|
1743
1975
|
'pti_card',
|
|
1744
1976
|
'brivo_credential',
|
|
@@ -1748,28 +1980,47 @@ export default {
|
|
|
1748
1980
|
],
|
|
1749
1981
|
type: 'string',
|
|
1750
1982
|
},
|
|
1751
|
-
external_type_display_name: {
|
|
1983
|
+
external_type_display_name: {
|
|
1984
|
+
description:
|
|
1985
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1986
|
+
type: 'string',
|
|
1987
|
+
},
|
|
1752
1988
|
is_issued: { type: 'boolean' },
|
|
1753
1989
|
is_latest_desired_state_synced_with_provider: {
|
|
1990
|
+
description:
|
|
1991
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1754
1992
|
type: 'boolean',
|
|
1755
1993
|
},
|
|
1756
1994
|
is_managed: { enum: [true], type: 'boolean' },
|
|
1757
|
-
is_multi_phone_sync_credential: {
|
|
1995
|
+
is_multi_phone_sync_credential: {
|
|
1996
|
+
description:
|
|
1997
|
+
'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).',
|
|
1998
|
+
type: 'boolean',
|
|
1999
|
+
},
|
|
1758
2000
|
issued_at: {
|
|
1759
2001
|
format: 'date-time',
|
|
1760
2002
|
nullable: true,
|
|
1761
2003
|
type: 'string',
|
|
1762
2004
|
},
|
|
1763
2005
|
latest_desired_state_synced_with_provider_at: {
|
|
2006
|
+
description:
|
|
2007
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1764
2008
|
format: 'date-time',
|
|
1765
2009
|
type: 'string',
|
|
1766
2010
|
},
|
|
1767
2011
|
parent_acs_credential_id: {
|
|
2012
|
+
description: 'ID of the parent credential.',
|
|
1768
2013
|
format: 'uuid',
|
|
1769
2014
|
type: 'string',
|
|
1770
2015
|
},
|
|
1771
|
-
starts_at: {
|
|
2016
|
+
starts_at: {
|
|
2017
|
+
description:
|
|
2018
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
2019
|
+
type: 'string',
|
|
2020
|
+
},
|
|
1772
2021
|
visionline_metadata: {
|
|
2022
|
+
description:
|
|
2023
|
+
'Visionline-specific metadata for the credential.',
|
|
1773
2024
|
properties: {
|
|
1774
2025
|
auto_join: { type: 'boolean' },
|
|
1775
2026
|
card_function_type: {
|
|
@@ -1806,7 +2057,12 @@ export default {
|
|
|
1806
2057
|
},
|
|
1807
2058
|
type: 'array',
|
|
1808
2059
|
},
|
|
1809
|
-
workspace_id: {
|
|
2060
|
+
workspace_id: {
|
|
2061
|
+
description:
|
|
2062
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
2063
|
+
format: 'uuid',
|
|
2064
|
+
type: 'string',
|
|
2065
|
+
},
|
|
1810
2066
|
},
|
|
1811
2067
|
required: [
|
|
1812
2068
|
'acs_credential_id',
|
|
@@ -1822,23 +2078,59 @@ export default {
|
|
|
1822
2078
|
type: 'object',
|
|
1823
2079
|
},
|
|
1824
2080
|
{
|
|
2081
|
+
description:
|
|
2082
|
+
'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.',
|
|
1825
2083
|
properties: {
|
|
1826
2084
|
access_method: {
|
|
2085
|
+
description:
|
|
2086
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1827
2087
|
enum: ['code', 'card', 'mobile_key'],
|
|
1828
2088
|
type: 'string',
|
|
1829
2089
|
},
|
|
1830
|
-
acs_credential_id: {
|
|
2090
|
+
acs_credential_id: {
|
|
2091
|
+
description: 'ID of the credential.',
|
|
2092
|
+
format: 'uuid',
|
|
2093
|
+
type: 'string',
|
|
2094
|
+
},
|
|
1831
2095
|
acs_credential_pool_id: {
|
|
1832
2096
|
format: 'uuid',
|
|
1833
2097
|
type: 'string',
|
|
1834
2098
|
},
|
|
1835
|
-
acs_system_id: {
|
|
1836
|
-
|
|
2099
|
+
acs_system_id: {
|
|
2100
|
+
description:
|
|
2101
|
+
'ID of the access control system that contains the credential.',
|
|
2102
|
+
format: 'uuid',
|
|
2103
|
+
type: 'string',
|
|
2104
|
+
},
|
|
2105
|
+
acs_user_id: {
|
|
2106
|
+
description:
|
|
2107
|
+
'ID of the ACS user to whom the credential belongs.',
|
|
2108
|
+
format: 'uuid',
|
|
2109
|
+
type: 'string',
|
|
2110
|
+
},
|
|
1837
2111
|
card_number: { nullable: true, type: 'string' },
|
|
1838
|
-
code: {
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
2112
|
+
code: {
|
|
2113
|
+
description: 'Access (PIN) code for the credential.',
|
|
2114
|
+
nullable: true,
|
|
2115
|
+
type: 'string',
|
|
2116
|
+
},
|
|
2117
|
+
created_at: {
|
|
2118
|
+
description:
|
|
2119
|
+
'Date and time at which the credential was created.',
|
|
2120
|
+
format: 'date-time',
|
|
2121
|
+
type: 'string',
|
|
2122
|
+
},
|
|
2123
|
+
display_name: {
|
|
2124
|
+
description:
|
|
2125
|
+
'Display name that corresponds to the credential type.',
|
|
2126
|
+
minLength: 1,
|
|
2127
|
+
type: 'string',
|
|
2128
|
+
},
|
|
2129
|
+
ends_at: {
|
|
2130
|
+
description:
|
|
2131
|
+
'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`.',
|
|
2132
|
+
type: 'string',
|
|
2133
|
+
},
|
|
1842
2134
|
errors: {
|
|
1843
2135
|
items: {
|
|
1844
2136
|
properties: {
|
|
@@ -1851,6 +2143,8 @@ export default {
|
|
|
1851
2143
|
type: 'array',
|
|
1852
2144
|
},
|
|
1853
2145
|
external_type: {
|
|
2146
|
+
description:
|
|
2147
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1854
2148
|
enum: [
|
|
1855
2149
|
'pti_card',
|
|
1856
2150
|
'brivo_credential',
|
|
@@ -1860,28 +2154,47 @@ export default {
|
|
|
1860
2154
|
],
|
|
1861
2155
|
type: 'string',
|
|
1862
2156
|
},
|
|
1863
|
-
external_type_display_name: {
|
|
2157
|
+
external_type_display_name: {
|
|
2158
|
+
description:
|
|
2159
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
2160
|
+
type: 'string',
|
|
2161
|
+
},
|
|
1864
2162
|
is_issued: { type: 'boolean' },
|
|
1865
2163
|
is_latest_desired_state_synced_with_provider: {
|
|
2164
|
+
description:
|
|
2165
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1866
2166
|
type: 'boolean',
|
|
1867
2167
|
},
|
|
1868
2168
|
is_managed: { enum: [false], type: 'boolean' },
|
|
1869
|
-
is_multi_phone_sync_credential: {
|
|
2169
|
+
is_multi_phone_sync_credential: {
|
|
2170
|
+
description:
|
|
2171
|
+
'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).',
|
|
2172
|
+
type: 'boolean',
|
|
2173
|
+
},
|
|
1870
2174
|
issued_at: {
|
|
1871
2175
|
format: 'date-time',
|
|
1872
2176
|
nullable: true,
|
|
1873
2177
|
type: 'string',
|
|
1874
2178
|
},
|
|
1875
2179
|
latest_desired_state_synced_with_provider_at: {
|
|
2180
|
+
description:
|
|
2181
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1876
2182
|
format: 'date-time',
|
|
1877
2183
|
type: 'string',
|
|
1878
2184
|
},
|
|
1879
2185
|
parent_acs_credential_id: {
|
|
2186
|
+
description: 'ID of the parent credential.',
|
|
1880
2187
|
format: 'uuid',
|
|
1881
2188
|
type: 'string',
|
|
1882
2189
|
},
|
|
1883
|
-
starts_at: {
|
|
2190
|
+
starts_at: {
|
|
2191
|
+
description:
|
|
2192
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
2193
|
+
type: 'string',
|
|
2194
|
+
},
|
|
1884
2195
|
visionline_metadata: {
|
|
2196
|
+
description:
|
|
2197
|
+
'Visionline-specific metadata for the credential.',
|
|
1885
2198
|
properties: {
|
|
1886
2199
|
auto_join: { type: 'boolean' },
|
|
1887
2200
|
card_function_type: {
|
|
@@ -1918,7 +2231,12 @@ export default {
|
|
|
1918
2231
|
},
|
|
1919
2232
|
type: 'array',
|
|
1920
2233
|
},
|
|
1921
|
-
workspace_id: {
|
|
2234
|
+
workspace_id: {
|
|
2235
|
+
description:
|
|
2236
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
2237
|
+
format: 'uuid',
|
|
2238
|
+
type: 'string',
|
|
2239
|
+
},
|
|
1922
2240
|
},
|
|
1923
2241
|
required: [
|
|
1924
2242
|
'acs_credential_id',
|
|
@@ -7485,14 +7803,24 @@ export default {
|
|
|
7485
7803
|
},
|
|
7486
7804
|
'/acs/credentials/assign': {
|
|
7487
7805
|
patch: {
|
|
7806
|
+
description:
|
|
7807
|
+
'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).',
|
|
7488
7808
|
operationId: 'acsCredentialsAssignPatch',
|
|
7489
7809
|
requestBody: {
|
|
7490
7810
|
content: {
|
|
7491
7811
|
'application/json': {
|
|
7492
7812
|
schema: {
|
|
7493
7813
|
properties: {
|
|
7494
|
-
acs_credential_id: {
|
|
7495
|
-
|
|
7814
|
+
acs_credential_id: {
|
|
7815
|
+
description: 'ID of the desired credential.',
|
|
7816
|
+
format: 'uuid',
|
|
7817
|
+
type: 'string',
|
|
7818
|
+
},
|
|
7819
|
+
acs_user_id: {
|
|
7820
|
+
description: 'ID of the desired user.',
|
|
7821
|
+
format: 'uuid',
|
|
7822
|
+
type: 'string',
|
|
7823
|
+
},
|
|
7496
7824
|
},
|
|
7497
7825
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7498
7826
|
type: 'object',
|
|
@@ -7530,16 +7858,27 @@ export default {
|
|
|
7530
7858
|
tags: ['/acs'],
|
|
7531
7859
|
'x-fern-ignore': true,
|
|
7532
7860
|
'x-response-key': null,
|
|
7861
|
+
'x-title': 'Assign a Credential to an ACS User',
|
|
7533
7862
|
},
|
|
7534
7863
|
post: {
|
|
7864
|
+
description:
|
|
7865
|
+
'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).',
|
|
7535
7866
|
operationId: 'acsCredentialsAssignPost',
|
|
7536
7867
|
requestBody: {
|
|
7537
7868
|
content: {
|
|
7538
7869
|
'application/json': {
|
|
7539
7870
|
schema: {
|
|
7540
7871
|
properties: {
|
|
7541
|
-
acs_credential_id: {
|
|
7542
|
-
|
|
7872
|
+
acs_credential_id: {
|
|
7873
|
+
description: 'ID of the desired credential.',
|
|
7874
|
+
format: 'uuid',
|
|
7875
|
+
type: 'string',
|
|
7876
|
+
},
|
|
7877
|
+
acs_user_id: {
|
|
7878
|
+
description: 'ID of the desired user.',
|
|
7879
|
+
format: 'uuid',
|
|
7880
|
+
type: 'string',
|
|
7881
|
+
},
|
|
7543
7882
|
},
|
|
7544
7883
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7545
7884
|
type: 'object',
|
|
@@ -7578,10 +7917,13 @@ export default {
|
|
|
7578
7917
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
7579
7918
|
'x-fern-sdk-method-name': 'assign',
|
|
7580
7919
|
'x-response-key': null,
|
|
7920
|
+
'x-title': 'Assign a Credential to an ACS User',
|
|
7581
7921
|
},
|
|
7582
7922
|
},
|
|
7583
7923
|
'/acs/credentials/create': {
|
|
7584
7924
|
post: {
|
|
7925
|
+
description:
|
|
7926
|
+
'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).',
|
|
7585
7927
|
operationId: 'acsCredentialsCreatePost',
|
|
7586
7928
|
requestBody: {
|
|
7587
7929
|
content: {
|
|
@@ -7589,27 +7931,57 @@ export default {
|
|
|
7589
7931
|
schema: {
|
|
7590
7932
|
properties: {
|
|
7591
7933
|
access_method: {
|
|
7934
|
+
description:
|
|
7935
|
+
'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
7592
7936
|
enum: ['code', 'card', 'mobile_key'],
|
|
7593
7937
|
type: 'string',
|
|
7594
7938
|
},
|
|
7595
|
-
acs_user_id: {
|
|
7939
|
+
acs_user_id: {
|
|
7940
|
+
description:
|
|
7941
|
+
'ID of the ACS user to whom the new credential belongs.',
|
|
7942
|
+
format: 'uuid',
|
|
7943
|
+
type: 'string',
|
|
7944
|
+
},
|
|
7596
7945
|
allowed_acs_entrance_ids: {
|
|
7597
7946
|
default: [],
|
|
7947
|
+
description:
|
|
7948
|
+
'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.',
|
|
7598
7949
|
items: { format: 'uuid', type: 'string' },
|
|
7599
7950
|
type: 'array',
|
|
7600
7951
|
},
|
|
7601
|
-
code: {
|
|
7952
|
+
code: {
|
|
7953
|
+
description:
|
|
7954
|
+
'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).',
|
|
7955
|
+
pattern: '^\\d+$',
|
|
7956
|
+
type: 'string',
|
|
7957
|
+
},
|
|
7602
7958
|
credential_manager_acs_system_id: {
|
|
7959
|
+
description:
|
|
7960
|
+
'ACS system ID of the credential manager for the new credential.',
|
|
7603
7961
|
format: 'uuid',
|
|
7604
7962
|
type: 'string',
|
|
7605
7963
|
},
|
|
7606
|
-
ends_at: {
|
|
7964
|
+
ends_at: {
|
|
7965
|
+
description:
|
|
7966
|
+
'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`.',
|
|
7967
|
+
format: 'date-time',
|
|
7968
|
+
type: 'string',
|
|
7969
|
+
},
|
|
7607
7970
|
is_multi_phone_sync_credential: {
|
|
7608
7971
|
default: false,
|
|
7972
|
+
description:
|
|
7973
|
+
'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).',
|
|
7609
7974
|
type: 'boolean',
|
|
7610
7975
|
},
|
|
7611
|
-
starts_at: {
|
|
7976
|
+
starts_at: {
|
|
7977
|
+
description:
|
|
7978
|
+
'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.',
|
|
7979
|
+
format: 'date-time',
|
|
7980
|
+
type: 'string',
|
|
7981
|
+
},
|
|
7612
7982
|
visionline_metadata: {
|
|
7983
|
+
description:
|
|
7984
|
+
'Visionline-specific metadata for the new credential.',
|
|
7613
7985
|
properties: {
|
|
7614
7986
|
assa_abloy_credential_service_mobile_endpoint_id: {
|
|
7615
7987
|
format: 'uuid',
|
|
@@ -7677,17 +8049,24 @@ export default {
|
|
|
7677
8049
|
'x-fern-sdk-method-name': 'create',
|
|
7678
8050
|
'x-fern-sdk-return-value': 'acs_credential',
|
|
7679
8051
|
'x-response-key': 'acs_credential',
|
|
8052
|
+
'x-title': 'Create a Credential for an ACS User',
|
|
7680
8053
|
},
|
|
7681
8054
|
},
|
|
7682
8055
|
'/acs/credentials/delete': {
|
|
7683
8056
|
post: {
|
|
8057
|
+
description:
|
|
8058
|
+
'Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7684
8059
|
operationId: 'acsCredentialsDeletePost',
|
|
7685
8060
|
requestBody: {
|
|
7686
8061
|
content: {
|
|
7687
8062
|
'application/json': {
|
|
7688
8063
|
schema: {
|
|
7689
8064
|
properties: {
|
|
7690
|
-
acs_credential_id: {
|
|
8065
|
+
acs_credential_id: {
|
|
8066
|
+
description: 'ID of the desired credential.',
|
|
8067
|
+
format: 'uuid',
|
|
8068
|
+
type: 'string',
|
|
8069
|
+
},
|
|
7691
8070
|
},
|
|
7692
8071
|
required: ['acs_credential_id'],
|
|
7693
8072
|
type: 'object',
|
|
@@ -7721,17 +8100,24 @@ export default {
|
|
|
7721
8100
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
7722
8101
|
'x-fern-sdk-method-name': 'delete',
|
|
7723
8102
|
'x-response-key': null,
|
|
8103
|
+
'x-title': 'Delete a Credential',
|
|
7724
8104
|
},
|
|
7725
8105
|
},
|
|
7726
8106
|
'/acs/credentials/get': {
|
|
7727
8107
|
post: {
|
|
8108
|
+
description:
|
|
8109
|
+
'Returns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7728
8110
|
operationId: 'acsCredentialsGetPost',
|
|
7729
8111
|
requestBody: {
|
|
7730
8112
|
content: {
|
|
7731
8113
|
'application/json': {
|
|
7732
8114
|
schema: {
|
|
7733
8115
|
properties: {
|
|
7734
|
-
acs_credential_id: {
|
|
8116
|
+
acs_credential_id: {
|
|
8117
|
+
description: 'ID of the desired credential.',
|
|
8118
|
+
format: 'uuid',
|
|
8119
|
+
type: 'string',
|
|
8120
|
+
},
|
|
7735
8121
|
},
|
|
7736
8122
|
required: ['acs_credential_id'],
|
|
7737
8123
|
type: 'object',
|
|
@@ -7771,10 +8157,13 @@ export default {
|
|
|
7771
8157
|
'x-fern-sdk-method-name': 'get',
|
|
7772
8158
|
'x-fern-sdk-return-value': 'acs_credential',
|
|
7773
8159
|
'x-response-key': 'acs_credential',
|
|
8160
|
+
'x-title': 'Get a Credential',
|
|
7774
8161
|
},
|
|
7775
8162
|
},
|
|
7776
8163
|
'/acs/credentials/list': {
|
|
7777
8164
|
post: {
|
|
8165
|
+
description:
|
|
8166
|
+
'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7778
8167
|
operationId: 'acsCredentialsListPost',
|
|
7779
8168
|
requestBody: {
|
|
7780
8169
|
content: {
|
|
@@ -7785,29 +8174,54 @@ export default {
|
|
|
7785
8174
|
oneOf: [
|
|
7786
8175
|
{
|
|
7787
8176
|
properties: {
|
|
7788
|
-
acs_user_id: {
|
|
8177
|
+
acs_user_id: {
|
|
8178
|
+
description:
|
|
8179
|
+
'ID of the ACS user for which you want to retrieve all credentials.',
|
|
8180
|
+
format: 'uuid',
|
|
8181
|
+
type: 'string',
|
|
8182
|
+
},
|
|
7789
8183
|
},
|
|
7790
8184
|
required: ['acs_user_id'],
|
|
7791
8185
|
type: 'object',
|
|
7792
8186
|
},
|
|
7793
8187
|
{
|
|
7794
8188
|
properties: {
|
|
7795
|
-
acs_system_id: {
|
|
8189
|
+
acs_system_id: {
|
|
8190
|
+
description:
|
|
8191
|
+
'ID of the access control system for which you want to retrieve all credentials.',
|
|
8192
|
+
format: 'uuid',
|
|
8193
|
+
type: 'string',
|
|
8194
|
+
},
|
|
7796
8195
|
},
|
|
7797
8196
|
required: ['acs_system_id'],
|
|
7798
8197
|
type: 'object',
|
|
7799
8198
|
},
|
|
7800
8199
|
{
|
|
7801
8200
|
properties: {
|
|
7802
|
-
acs_system_id: {
|
|
7803
|
-
|
|
8201
|
+
acs_system_id: {
|
|
8202
|
+
description:
|
|
8203
|
+
'ID of the access control system for which you want to retrieve all credentials.',
|
|
8204
|
+
format: 'uuid',
|
|
8205
|
+
type: 'string',
|
|
8206
|
+
},
|
|
8207
|
+
acs_user_id: {
|
|
8208
|
+
description:
|
|
8209
|
+
'ID of the ACS user for which you want to retrieve all credentials.',
|
|
8210
|
+
format: 'uuid',
|
|
8211
|
+
type: 'string',
|
|
8212
|
+
},
|
|
7804
8213
|
},
|
|
7805
8214
|
required: ['acs_user_id', 'acs_system_id'],
|
|
7806
8215
|
type: 'object',
|
|
7807
8216
|
},
|
|
7808
8217
|
{
|
|
7809
8218
|
properties: {
|
|
7810
|
-
user_identity_id: {
|
|
8219
|
+
user_identity_id: {
|
|
8220
|
+
description:
|
|
8221
|
+
'ID of the user identity for which you want to retrieve all credentials.',
|
|
8222
|
+
format: 'uuid',
|
|
8223
|
+
type: 'string',
|
|
8224
|
+
},
|
|
7811
8225
|
},
|
|
7812
8226
|
required: ['user_identity_id'],
|
|
7813
8227
|
type: 'object',
|
|
@@ -7816,9 +8230,23 @@ export default {
|
|
|
7816
8230
|
},
|
|
7817
8231
|
{
|
|
7818
8232
|
properties: {
|
|
7819
|
-
created_before: {
|
|
7820
|
-
|
|
7821
|
-
|
|
8233
|
+
created_before: {
|
|
8234
|
+
description:
|
|
8235
|
+
'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.',
|
|
8236
|
+
format: 'date-time',
|
|
8237
|
+
type: 'string',
|
|
8238
|
+
},
|
|
8239
|
+
is_multi_phone_sync_credential: {
|
|
8240
|
+
description:
|
|
8241
|
+
'Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.',
|
|
8242
|
+
type: 'boolean',
|
|
8243
|
+
},
|
|
8244
|
+
limit: {
|
|
8245
|
+
default: 500,
|
|
8246
|
+
description: 'Number of credentials to return.',
|
|
8247
|
+
format: 'float',
|
|
8248
|
+
type: 'number',
|
|
8249
|
+
},
|
|
7822
8250
|
},
|
|
7823
8251
|
type: 'object',
|
|
7824
8252
|
},
|
|
@@ -7861,17 +8289,25 @@ export default {
|
|
|
7861
8289
|
'x-fern-sdk-method-name': 'list',
|
|
7862
8290
|
'x-fern-sdk-return-value': 'acs_credentials',
|
|
7863
8291
|
'x-response-key': 'acs_credentials',
|
|
8292
|
+
'x-title': 'List Credentials',
|
|
7864
8293
|
},
|
|
7865
8294
|
},
|
|
7866
8295
|
'/acs/credentials/list_accessible_entrances': {
|
|
7867
8296
|
post: {
|
|
8297
|
+
description:
|
|
8298
|
+
'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.',
|
|
7868
8299
|
operationId: 'acsCredentialsListAccessibleEntrancesPost',
|
|
7869
8300
|
requestBody: {
|
|
7870
8301
|
content: {
|
|
7871
8302
|
'application/json': {
|
|
7872
8303
|
schema: {
|
|
7873
8304
|
properties: {
|
|
7874
|
-
acs_credential_id: {
|
|
8305
|
+
acs_credential_id: {
|
|
8306
|
+
description:
|
|
8307
|
+
'ID of the credential for which you want to retrieve all entrances to which this credential grants access.',
|
|
8308
|
+
format: 'uuid',
|
|
8309
|
+
type: 'string',
|
|
8310
|
+
},
|
|
7875
8311
|
},
|
|
7876
8312
|
required: ['acs_credential_id'],
|
|
7877
8313
|
type: 'object',
|
|
@@ -7912,18 +8348,29 @@ export default {
|
|
|
7912
8348
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
7913
8349
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
7914
8350
|
'x-response-key': 'acs_entrances',
|
|
8351
|
+
'x-title': 'List Accessible Entrances',
|
|
7915
8352
|
},
|
|
7916
8353
|
},
|
|
7917
8354
|
'/acs/credentials/unassign': {
|
|
7918
8355
|
patch: {
|
|
8356
|
+
description:
|
|
8357
|
+
'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).',
|
|
7919
8358
|
operationId: 'acsCredentialsUnassignPatch',
|
|
7920
8359
|
requestBody: {
|
|
7921
8360
|
content: {
|
|
7922
8361
|
'application/json': {
|
|
7923
8362
|
schema: {
|
|
7924
8363
|
properties: {
|
|
7925
|
-
acs_credential_id: {
|
|
7926
|
-
|
|
8364
|
+
acs_credential_id: {
|
|
8365
|
+
description: 'ID of the desired credential.',
|
|
8366
|
+
format: 'uuid',
|
|
8367
|
+
type: 'string',
|
|
8368
|
+
},
|
|
8369
|
+
acs_user_id: {
|
|
8370
|
+
description: 'ID of the desired user.',
|
|
8371
|
+
format: 'uuid',
|
|
8372
|
+
type: 'string',
|
|
8373
|
+
},
|
|
7927
8374
|
},
|
|
7928
8375
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7929
8376
|
type: 'object',
|
|
@@ -7961,16 +8408,27 @@ export default {
|
|
|
7961
8408
|
tags: ['/acs'],
|
|
7962
8409
|
'x-fern-ignore': true,
|
|
7963
8410
|
'x-response-key': null,
|
|
8411
|
+
'x-title': 'Unassign a Credential from an ACS User',
|
|
7964
8412
|
},
|
|
7965
8413
|
post: {
|
|
8414
|
+
description:
|
|
8415
|
+
'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).',
|
|
7966
8416
|
operationId: 'acsCredentialsUnassignPost',
|
|
7967
8417
|
requestBody: {
|
|
7968
8418
|
content: {
|
|
7969
8419
|
'application/json': {
|
|
7970
8420
|
schema: {
|
|
7971
8421
|
properties: {
|
|
7972
|
-
acs_credential_id: {
|
|
7973
|
-
|
|
8422
|
+
acs_credential_id: {
|
|
8423
|
+
description: 'ID of the desired credential.',
|
|
8424
|
+
format: 'uuid',
|
|
8425
|
+
type: 'string',
|
|
8426
|
+
},
|
|
8427
|
+
acs_user_id: {
|
|
8428
|
+
description: 'ID of the desired user.',
|
|
8429
|
+
format: 'uuid',
|
|
8430
|
+
type: 'string',
|
|
8431
|
+
},
|
|
7974
8432
|
},
|
|
7975
8433
|
required: ['acs_user_id', 'acs_credential_id'],
|
|
7976
8434
|
type: 'object',
|
|
@@ -8009,17 +8467,24 @@ export default {
|
|
|
8009
8467
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
8010
8468
|
'x-fern-sdk-method-name': 'unassign',
|
|
8011
8469
|
'x-response-key': null,
|
|
8470
|
+
'x-title': 'Unassign a Credential from an ACS User',
|
|
8012
8471
|
},
|
|
8013
8472
|
},
|
|
8014
8473
|
'/acs/credentials/unmanaged/get': {
|
|
8015
8474
|
post: {
|
|
8475
|
+
description:
|
|
8476
|
+
'Returns a specified unmanaged [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
8016
8477
|
operationId: 'acsCredentialsUnmanagedGetPost',
|
|
8017
8478
|
requestBody: {
|
|
8018
8479
|
content: {
|
|
8019
8480
|
'application/json': {
|
|
8020
8481
|
schema: {
|
|
8021
8482
|
properties: {
|
|
8022
|
-
acs_credential_id: {
|
|
8483
|
+
acs_credential_id: {
|
|
8484
|
+
description: 'ID of the desired unmanaged credential.',
|
|
8485
|
+
format: 'uuid',
|
|
8486
|
+
type: 'string',
|
|
8487
|
+
},
|
|
8023
8488
|
},
|
|
8024
8489
|
required: ['acs_credential_id'],
|
|
8025
8490
|
type: 'object',
|
|
@@ -8034,23 +8499,59 @@ export default {
|
|
|
8034
8499
|
schema: {
|
|
8035
8500
|
properties: {
|
|
8036
8501
|
acs_credential: {
|
|
8502
|
+
description:
|
|
8503
|
+
'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.',
|
|
8037
8504
|
properties: {
|
|
8038
8505
|
access_method: {
|
|
8506
|
+
description:
|
|
8507
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
8039
8508
|
enum: ['code', 'card', 'mobile_key'],
|
|
8040
8509
|
type: 'string',
|
|
8041
8510
|
},
|
|
8042
|
-
acs_credential_id: {
|
|
8511
|
+
acs_credential_id: {
|
|
8512
|
+
description: 'ID of the credential.',
|
|
8513
|
+
format: 'uuid',
|
|
8514
|
+
type: 'string',
|
|
8515
|
+
},
|
|
8043
8516
|
acs_credential_pool_id: {
|
|
8044
8517
|
format: 'uuid',
|
|
8045
8518
|
type: 'string',
|
|
8046
8519
|
},
|
|
8047
|
-
acs_system_id: {
|
|
8048
|
-
|
|
8520
|
+
acs_system_id: {
|
|
8521
|
+
description:
|
|
8522
|
+
'ID of the access control system that contains the credential.',
|
|
8523
|
+
format: 'uuid',
|
|
8524
|
+
type: 'string',
|
|
8525
|
+
},
|
|
8526
|
+
acs_user_id: {
|
|
8527
|
+
description:
|
|
8528
|
+
'ID of the ACS user to whom the credential belongs.',
|
|
8529
|
+
format: 'uuid',
|
|
8530
|
+
type: 'string',
|
|
8531
|
+
},
|
|
8049
8532
|
card_number: { nullable: true, type: 'string' },
|
|
8050
|
-
code: {
|
|
8051
|
-
|
|
8052
|
-
|
|
8053
|
-
|
|
8533
|
+
code: {
|
|
8534
|
+
description: 'Access (PIN) code for the credential.',
|
|
8535
|
+
nullable: true,
|
|
8536
|
+
type: 'string',
|
|
8537
|
+
},
|
|
8538
|
+
created_at: {
|
|
8539
|
+
description:
|
|
8540
|
+
'Date and time at which the credential was created.',
|
|
8541
|
+
format: 'date-time',
|
|
8542
|
+
type: 'string',
|
|
8543
|
+
},
|
|
8544
|
+
display_name: {
|
|
8545
|
+
description:
|
|
8546
|
+
'Display name that corresponds to the credential type.',
|
|
8547
|
+
minLength: 1,
|
|
8548
|
+
type: 'string',
|
|
8549
|
+
},
|
|
8550
|
+
ends_at: {
|
|
8551
|
+
description:
|
|
8552
|
+
'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`.',
|
|
8553
|
+
type: 'string',
|
|
8554
|
+
},
|
|
8054
8555
|
errors: {
|
|
8055
8556
|
items: {
|
|
8056
8557
|
properties: {
|
|
@@ -8063,6 +8564,8 @@ export default {
|
|
|
8063
8564
|
type: 'array',
|
|
8064
8565
|
},
|
|
8065
8566
|
external_type: {
|
|
8567
|
+
description:
|
|
8568
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
8066
8569
|
enum: [
|
|
8067
8570
|
'pti_card',
|
|
8068
8571
|
'brivo_credential',
|
|
@@ -8072,28 +8575,47 @@ export default {
|
|
|
8072
8575
|
],
|
|
8073
8576
|
type: 'string',
|
|
8074
8577
|
},
|
|
8075
|
-
external_type_display_name: {
|
|
8578
|
+
external_type_display_name: {
|
|
8579
|
+
description:
|
|
8580
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
8581
|
+
type: 'string',
|
|
8582
|
+
},
|
|
8076
8583
|
is_issued: { type: 'boolean' },
|
|
8077
8584
|
is_latest_desired_state_synced_with_provider: {
|
|
8585
|
+
description:
|
|
8586
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
8078
8587
|
type: 'boolean',
|
|
8079
8588
|
},
|
|
8080
8589
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8081
|
-
is_multi_phone_sync_credential: {
|
|
8590
|
+
is_multi_phone_sync_credential: {
|
|
8591
|
+
description:
|
|
8592
|
+
'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).',
|
|
8593
|
+
type: 'boolean',
|
|
8594
|
+
},
|
|
8082
8595
|
issued_at: {
|
|
8083
8596
|
format: 'date-time',
|
|
8084
8597
|
nullable: true,
|
|
8085
8598
|
type: 'string',
|
|
8086
8599
|
},
|
|
8087
8600
|
latest_desired_state_synced_with_provider_at: {
|
|
8601
|
+
description:
|
|
8602
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
8088
8603
|
format: 'date-time',
|
|
8089
8604
|
type: 'string',
|
|
8090
8605
|
},
|
|
8091
8606
|
parent_acs_credential_id: {
|
|
8607
|
+
description: 'ID of the parent credential.',
|
|
8092
8608
|
format: 'uuid',
|
|
8093
8609
|
type: 'string',
|
|
8094
8610
|
},
|
|
8095
|
-
starts_at: {
|
|
8611
|
+
starts_at: {
|
|
8612
|
+
description:
|
|
8613
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
8614
|
+
type: 'string',
|
|
8615
|
+
},
|
|
8096
8616
|
visionline_metadata: {
|
|
8617
|
+
description:
|
|
8618
|
+
'Visionline-specific metadata for the credential.',
|
|
8097
8619
|
properties: {
|
|
8098
8620
|
auto_join: { type: 'boolean' },
|
|
8099
8621
|
card_function_type: {
|
|
@@ -8130,7 +8652,12 @@ export default {
|
|
|
8130
8652
|
},
|
|
8131
8653
|
type: 'array',
|
|
8132
8654
|
},
|
|
8133
|
-
workspace_id: {
|
|
8655
|
+
workspace_id: {
|
|
8656
|
+
description:
|
|
8657
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
8658
|
+
format: 'uuid',
|
|
8659
|
+
type: 'string',
|
|
8660
|
+
},
|
|
8134
8661
|
},
|
|
8135
8662
|
required: [
|
|
8136
8663
|
'acs_credential_id',
|
|
@@ -8168,10 +8695,13 @@ export default {
|
|
|
8168
8695
|
'x-fern-sdk-method-name': 'get',
|
|
8169
8696
|
'x-fern-sdk-return-value': 'acs_credential',
|
|
8170
8697
|
'x-response-key': 'acs_credential',
|
|
8698
|
+
'x-title': 'Get an Unmanaged Credential',
|
|
8171
8699
|
},
|
|
8172
8700
|
},
|
|
8173
8701
|
'/acs/credentials/unmanaged/list': {
|
|
8174
8702
|
post: {
|
|
8703
|
+
description:
|
|
8704
|
+
'Returns a list of all unmanaged [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
8175
8705
|
operationId: 'acsCredentialsUnmanagedListPost',
|
|
8176
8706
|
requestBody: {
|
|
8177
8707
|
content: {
|
|
@@ -8180,29 +8710,54 @@ export default {
|
|
|
8180
8710
|
oneOf: [
|
|
8181
8711
|
{
|
|
8182
8712
|
properties: {
|
|
8183
|
-
acs_user_id: {
|
|
8713
|
+
acs_user_id: {
|
|
8714
|
+
description:
|
|
8715
|
+
'ID of the ACS user for which you want to retrieve all credentials.',
|
|
8716
|
+
format: 'uuid',
|
|
8717
|
+
type: 'string',
|
|
8718
|
+
},
|
|
8184
8719
|
},
|
|
8185
8720
|
required: ['acs_user_id'],
|
|
8186
8721
|
type: 'object',
|
|
8187
8722
|
},
|
|
8188
8723
|
{
|
|
8189
8724
|
properties: {
|
|
8190
|
-
acs_system_id: {
|
|
8725
|
+
acs_system_id: {
|
|
8726
|
+
description:
|
|
8727
|
+
'ID of the access control system for which you want to retrieve all credentials.',
|
|
8728
|
+
format: 'uuid',
|
|
8729
|
+
type: 'string',
|
|
8730
|
+
},
|
|
8191
8731
|
},
|
|
8192
8732
|
required: ['acs_system_id'],
|
|
8193
8733
|
type: 'object',
|
|
8194
8734
|
},
|
|
8195
8735
|
{
|
|
8196
8736
|
properties: {
|
|
8197
|
-
acs_system_id: {
|
|
8198
|
-
|
|
8737
|
+
acs_system_id: {
|
|
8738
|
+
description:
|
|
8739
|
+
'ID of the access control system for which you want to retrieve all credentials.',
|
|
8740
|
+
format: 'uuid',
|
|
8741
|
+
type: 'string',
|
|
8742
|
+
},
|
|
8743
|
+
acs_user_id: {
|
|
8744
|
+
description:
|
|
8745
|
+
'ID of the ACS user for which you want to retrieve all credentials.',
|
|
8746
|
+
format: 'uuid',
|
|
8747
|
+
type: 'string',
|
|
8748
|
+
},
|
|
8199
8749
|
},
|
|
8200
8750
|
required: ['acs_user_id', 'acs_system_id'],
|
|
8201
8751
|
type: 'object',
|
|
8202
8752
|
},
|
|
8203
8753
|
{
|
|
8204
8754
|
properties: {
|
|
8205
|
-
user_identity_id: {
|
|
8755
|
+
user_identity_id: {
|
|
8756
|
+
description:
|
|
8757
|
+
'ID of the user identity for which you want to retrieve all credentials.',
|
|
8758
|
+
format: 'uuid',
|
|
8759
|
+
type: 'string',
|
|
8760
|
+
},
|
|
8206
8761
|
},
|
|
8207
8762
|
required: ['user_identity_id'],
|
|
8208
8763
|
type: 'object',
|
|
@@ -8220,23 +8775,60 @@ export default {
|
|
|
8220
8775
|
properties: {
|
|
8221
8776
|
acs_credentials: {
|
|
8222
8777
|
items: {
|
|
8778
|
+
description:
|
|
8779
|
+
'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.',
|
|
8223
8780
|
properties: {
|
|
8224
8781
|
access_method: {
|
|
8782
|
+
description:
|
|
8783
|
+
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
8225
8784
|
enum: ['code', 'card', 'mobile_key'],
|
|
8226
8785
|
type: 'string',
|
|
8227
8786
|
},
|
|
8228
|
-
acs_credential_id: {
|
|
8787
|
+
acs_credential_id: {
|
|
8788
|
+
description: 'ID of the credential.',
|
|
8789
|
+
format: 'uuid',
|
|
8790
|
+
type: 'string',
|
|
8791
|
+
},
|
|
8229
8792
|
acs_credential_pool_id: {
|
|
8230
8793
|
format: 'uuid',
|
|
8231
8794
|
type: 'string',
|
|
8232
8795
|
},
|
|
8233
|
-
acs_system_id: {
|
|
8234
|
-
|
|
8796
|
+
acs_system_id: {
|
|
8797
|
+
description:
|
|
8798
|
+
'ID of the access control system that contains the credential.',
|
|
8799
|
+
format: 'uuid',
|
|
8800
|
+
type: 'string',
|
|
8801
|
+
},
|
|
8802
|
+
acs_user_id: {
|
|
8803
|
+
description:
|
|
8804
|
+
'ID of the ACS user to whom the credential belongs.',
|
|
8805
|
+
format: 'uuid',
|
|
8806
|
+
type: 'string',
|
|
8807
|
+
},
|
|
8235
8808
|
card_number: { nullable: true, type: 'string' },
|
|
8236
|
-
code: {
|
|
8237
|
-
|
|
8238
|
-
|
|
8239
|
-
|
|
8809
|
+
code: {
|
|
8810
|
+
description:
|
|
8811
|
+
'Access (PIN) code for the credential.',
|
|
8812
|
+
nullable: true,
|
|
8813
|
+
type: 'string',
|
|
8814
|
+
},
|
|
8815
|
+
created_at: {
|
|
8816
|
+
description:
|
|
8817
|
+
'Date and time at which the credential was created.',
|
|
8818
|
+
format: 'date-time',
|
|
8819
|
+
type: 'string',
|
|
8820
|
+
},
|
|
8821
|
+
display_name: {
|
|
8822
|
+
description:
|
|
8823
|
+
'Display name that corresponds to the credential type.',
|
|
8824
|
+
minLength: 1,
|
|
8825
|
+
type: 'string',
|
|
8826
|
+
},
|
|
8827
|
+
ends_at: {
|
|
8828
|
+
description:
|
|
8829
|
+
'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`.',
|
|
8830
|
+
type: 'string',
|
|
8831
|
+
},
|
|
8240
8832
|
errors: {
|
|
8241
8833
|
items: {
|
|
8242
8834
|
properties: {
|
|
@@ -8249,6 +8841,8 @@ export default {
|
|
|
8249
8841
|
type: 'array',
|
|
8250
8842
|
},
|
|
8251
8843
|
external_type: {
|
|
8844
|
+
description:
|
|
8845
|
+
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
8252
8846
|
enum: [
|
|
8253
8847
|
'pti_card',
|
|
8254
8848
|
'brivo_credential',
|
|
@@ -8258,28 +8852,47 @@ export default {
|
|
|
8258
8852
|
],
|
|
8259
8853
|
type: 'string',
|
|
8260
8854
|
},
|
|
8261
|
-
external_type_display_name: {
|
|
8855
|
+
external_type_display_name: {
|
|
8856
|
+
description:
|
|
8857
|
+
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
8858
|
+
type: 'string',
|
|
8859
|
+
},
|
|
8262
8860
|
is_issued: { type: 'boolean' },
|
|
8263
8861
|
is_latest_desired_state_synced_with_provider: {
|
|
8862
|
+
description:
|
|
8863
|
+
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
8264
8864
|
type: 'boolean',
|
|
8265
8865
|
},
|
|
8266
8866
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8267
|
-
is_multi_phone_sync_credential: {
|
|
8867
|
+
is_multi_phone_sync_credential: {
|
|
8868
|
+
description:
|
|
8869
|
+
'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).',
|
|
8870
|
+
type: 'boolean',
|
|
8871
|
+
},
|
|
8268
8872
|
issued_at: {
|
|
8269
8873
|
format: 'date-time',
|
|
8270
8874
|
nullable: true,
|
|
8271
8875
|
type: 'string',
|
|
8272
8876
|
},
|
|
8273
8877
|
latest_desired_state_synced_with_provider_at: {
|
|
8878
|
+
description:
|
|
8879
|
+
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
8274
8880
|
format: 'date-time',
|
|
8275
8881
|
type: 'string',
|
|
8276
8882
|
},
|
|
8277
8883
|
parent_acs_credential_id: {
|
|
8884
|
+
description: 'ID of the parent credential.',
|
|
8278
8885
|
format: 'uuid',
|
|
8279
8886
|
type: 'string',
|
|
8280
8887
|
},
|
|
8281
|
-
starts_at: {
|
|
8888
|
+
starts_at: {
|
|
8889
|
+
description:
|
|
8890
|
+
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
8891
|
+
type: 'string',
|
|
8892
|
+
},
|
|
8282
8893
|
visionline_metadata: {
|
|
8894
|
+
description:
|
|
8895
|
+
'Visionline-specific metadata for the credential.',
|
|
8283
8896
|
properties: {
|
|
8284
8897
|
auto_join: { type: 'boolean' },
|
|
8285
8898
|
card_function_type: {
|
|
@@ -8316,7 +8929,12 @@ export default {
|
|
|
8316
8929
|
},
|
|
8317
8930
|
type: 'array',
|
|
8318
8931
|
},
|
|
8319
|
-
workspace_id: {
|
|
8932
|
+
workspace_id: {
|
|
8933
|
+
description:
|
|
8934
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
8935
|
+
format: 'uuid',
|
|
8936
|
+
type: 'string',
|
|
8937
|
+
},
|
|
8320
8938
|
},
|
|
8321
8939
|
required: [
|
|
8322
8940
|
'acs_credential_id',
|
|
@@ -8356,19 +8974,35 @@ export default {
|
|
|
8356
8974
|
'x-fern-sdk-method-name': 'list',
|
|
8357
8975
|
'x-fern-sdk-return-value': 'acs_credentials',
|
|
8358
8976
|
'x-response-key': 'acs_credentials',
|
|
8977
|
+
'x-title': 'List Unmanaged Credentials',
|
|
8359
8978
|
},
|
|
8360
8979
|
},
|
|
8361
8980
|
'/acs/credentials/update': {
|
|
8362
8981
|
patch: {
|
|
8982
|
+
description:
|
|
8983
|
+
'Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
8363
8984
|
operationId: 'acsCredentialsUpdatePatch',
|
|
8364
8985
|
requestBody: {
|
|
8365
8986
|
content: {
|
|
8366
8987
|
'application/json': {
|
|
8367
8988
|
schema: {
|
|
8368
8989
|
properties: {
|
|
8369
|
-
acs_credential_id: {
|
|
8370
|
-
|
|
8371
|
-
|
|
8990
|
+
acs_credential_id: {
|
|
8991
|
+
description: 'ID of the desired credential.',
|
|
8992
|
+
type: 'string',
|
|
8993
|
+
},
|
|
8994
|
+
code: {
|
|
8995
|
+
description:
|
|
8996
|
+
'Replacement access (PIN) code for the credential.',
|
|
8997
|
+
pattern: '^\\d+$',
|
|
8998
|
+
type: 'string',
|
|
8999
|
+
},
|
|
9000
|
+
ends_at: {
|
|
9001
|
+
description:
|
|
9002
|
+
'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.',
|
|
9003
|
+
format: 'date-time',
|
|
9004
|
+
type: 'string',
|
|
9005
|
+
},
|
|
8372
9006
|
},
|
|
8373
9007
|
required: ['acs_credential_id'],
|
|
8374
9008
|
type: 'object',
|
|
@@ -8406,17 +9040,33 @@ export default {
|
|
|
8406
9040
|
tags: ['/acs'],
|
|
8407
9041
|
'x-fern-ignore': true,
|
|
8408
9042
|
'x-response-key': null,
|
|
9043
|
+
'x-title': 'Update a Credential',
|
|
8409
9044
|
},
|
|
8410
9045
|
post: {
|
|
9046
|
+
description:
|
|
9047
|
+
'Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
8411
9048
|
operationId: 'acsCredentialsUpdatePost',
|
|
8412
9049
|
requestBody: {
|
|
8413
9050
|
content: {
|
|
8414
9051
|
'application/json': {
|
|
8415
9052
|
schema: {
|
|
8416
9053
|
properties: {
|
|
8417
|
-
acs_credential_id: {
|
|
8418
|
-
|
|
8419
|
-
|
|
9054
|
+
acs_credential_id: {
|
|
9055
|
+
description: 'ID of the desired credential.',
|
|
9056
|
+
type: 'string',
|
|
9057
|
+
},
|
|
9058
|
+
code: {
|
|
9059
|
+
description:
|
|
9060
|
+
'Replacement access (PIN) code for the credential.',
|
|
9061
|
+
pattern: '^\\d+$',
|
|
9062
|
+
type: 'string',
|
|
9063
|
+
},
|
|
9064
|
+
ends_at: {
|
|
9065
|
+
description:
|
|
9066
|
+
'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.',
|
|
9067
|
+
format: 'date-time',
|
|
9068
|
+
type: 'string',
|
|
9069
|
+
},
|
|
8420
9070
|
},
|
|
8421
9071
|
required: ['acs_credential_id'],
|
|
8422
9072
|
type: 'object',
|
|
@@ -8455,6 +9105,7 @@ export default {
|
|
|
8455
9105
|
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
8456
9106
|
'x-fern-sdk-method-name': 'update',
|
|
8457
9107
|
'x-response-key': null,
|
|
9108
|
+
'x-title': 'Update a Credential',
|
|
8458
9109
|
},
|
|
8459
9110
|
},
|
|
8460
9111
|
'/acs/encoders/encode_card': {
|