@seamapi/types 1.404.0 → 1.404.2
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 +504 -143
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +516 -23
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +55 -15
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +121 -41
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/custom-metadata.js +5 -2
- package/lib/seam/connect/models/custom-metadata.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +148 -9
- package/lib/seam/connect/openapi.js +378 -89
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +368 -14
- package/package.json +1 -1
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +79 -15
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +172 -44
- package/src/lib/seam/connect/models/custom-metadata.ts +8 -4
- package/src/lib/seam/connect/openapi.ts +471 -89
- package/src/lib/seam/connect/route-types.ts +368 -14
|
@@ -977,15 +977,24 @@ export default {
|
|
|
977
977
|
enum: ['invalid_credentials'],
|
|
978
978
|
type: 'string',
|
|
979
979
|
},
|
|
980
|
-
is_bridge_error: {
|
|
981
|
-
|
|
982
|
-
|
|
980
|
+
is_bridge_error: {
|
|
981
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
982
|
+
type: 'boolean',
|
|
983
|
+
},
|
|
984
|
+
is_connected_account_error: {
|
|
985
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
986
|
+
type: 'boolean',
|
|
987
|
+
},
|
|
988
|
+
message: {
|
|
989
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
990
|
+
type: 'string',
|
|
991
|
+
},
|
|
983
992
|
},
|
|
984
993
|
required: ['created_at', 'message', 'error_code'],
|
|
985
994
|
type: 'object',
|
|
986
995
|
},
|
|
987
996
|
{
|
|
988
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
997
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
989
998
|
properties: {
|
|
990
999
|
created_at: {
|
|
991
1000
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -997,9 +1006,18 @@ export default {
|
|
|
997
1006
|
enum: ['bridge_disconnected'],
|
|
998
1007
|
type: 'string',
|
|
999
1008
|
},
|
|
1000
|
-
is_bridge_error: {
|
|
1001
|
-
|
|
1002
|
-
|
|
1009
|
+
is_bridge_error: {
|
|
1010
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
1011
|
+
type: 'boolean',
|
|
1012
|
+
},
|
|
1013
|
+
is_connected_account_error: {
|
|
1014
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
1015
|
+
type: 'boolean',
|
|
1016
|
+
},
|
|
1017
|
+
message: {
|
|
1018
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1019
|
+
type: 'string',
|
|
1020
|
+
},
|
|
1003
1021
|
},
|
|
1004
1022
|
required: ['created_at', 'message', 'error_code'],
|
|
1005
1023
|
type: 'object',
|
|
@@ -6450,39 +6468,62 @@ export default {
|
|
|
6450
6468
|
'x-deprecated': 'Unused. Will be removed.',
|
|
6451
6469
|
'x-undocumented': 'Unused. Will be removed.',
|
|
6452
6470
|
},
|
|
6453
|
-
accepted_providers: {
|
|
6471
|
+
accepted_providers: {
|
|
6472
|
+
description: 'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
6473
|
+
items: { type: 'string' },
|
|
6474
|
+
type: 'array',
|
|
6475
|
+
},
|
|
6454
6476
|
any_device_allowed: {
|
|
6455
6477
|
deprecated: true,
|
|
6456
6478
|
type: 'boolean',
|
|
6457
6479
|
'x-deprecated': 'Unused. Will be removed.',
|
|
6458
6480
|
'x-undocumented': 'Unused. Will be removed.',
|
|
6459
6481
|
},
|
|
6460
|
-
any_provider_allowed: {
|
|
6482
|
+
any_provider_allowed: {
|
|
6483
|
+
description: 'Indicates whether any provider is allowed.',
|
|
6484
|
+
type: 'boolean',
|
|
6485
|
+
},
|
|
6461
6486
|
authorized_at: {
|
|
6487
|
+
description: 'Date and time at which the user authorized (through the Connect Webview) the management of their devices.',
|
|
6462
6488
|
format: 'date-time',
|
|
6463
6489
|
nullable: true,
|
|
6464
6490
|
type: 'string',
|
|
6465
6491
|
},
|
|
6466
|
-
automatically_manage_new_devices: {
|
|
6467
|
-
|
|
6492
|
+
automatically_manage_new_devices: {
|
|
6493
|
+
description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
|
|
6494
|
+
type: 'boolean',
|
|
6495
|
+
},
|
|
6496
|
+
connect_webview_id: {
|
|
6497
|
+
description: 'ID of the Connect Webview.',
|
|
6498
|
+
format: 'uuid',
|
|
6499
|
+
type: 'string',
|
|
6500
|
+
},
|
|
6468
6501
|
connected_account_id: {
|
|
6502
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.',
|
|
6469
6503
|
format: 'uuid',
|
|
6470
6504
|
nullable: true,
|
|
6471
6505
|
type: 'string',
|
|
6472
6506
|
},
|
|
6473
|
-
created_at: {
|
|
6507
|
+
created_at: {
|
|
6508
|
+
description: 'Date and time at which the Connect Webview was created.',
|
|
6509
|
+
format: 'date-time',
|
|
6510
|
+
type: 'string',
|
|
6511
|
+
},
|
|
6474
6512
|
custom_metadata: {
|
|
6475
6513
|
additionalProperties: {
|
|
6476
6514
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
6477
6515
|
},
|
|
6516
|
+
description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
|
|
6478
6517
|
type: 'object',
|
|
6479
6518
|
},
|
|
6480
6519
|
custom_redirect_failure_url: {
|
|
6520
|
+
description: 'URL to which the Connect Webview should redirect when an unexpected error occurs.',
|
|
6481
6521
|
format: 'uri',
|
|
6482
6522
|
nullable: true,
|
|
6483
6523
|
type: 'string',
|
|
6484
6524
|
},
|
|
6485
6525
|
custom_redirect_url: {
|
|
6526
|
+
description: 'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.',
|
|
6486
6527
|
format: 'uri',
|
|
6487
6528
|
nullable: true,
|
|
6488
6529
|
type: 'string',
|
|
@@ -6491,12 +6532,34 @@ export default {
|
|
|
6491
6532
|
enum: ['none', 'single', 'multiple'],
|
|
6492
6533
|
type: 'string',
|
|
6493
6534
|
},
|
|
6494
|
-
login_successful: {
|
|
6495
|
-
|
|
6496
|
-
|
|
6497
|
-
|
|
6498
|
-
|
|
6499
|
-
|
|
6535
|
+
login_successful: {
|
|
6536
|
+
description: 'Indicates whether the user logged in successfully using the Connect Webview.',
|
|
6537
|
+
type: 'boolean',
|
|
6538
|
+
},
|
|
6539
|
+
selected_provider: {
|
|
6540
|
+
description: 'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
6541
|
+
nullable: true,
|
|
6542
|
+
type: 'string',
|
|
6543
|
+
},
|
|
6544
|
+
status: {
|
|
6545
|
+
description: 'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.',
|
|
6546
|
+
enum: ['pending', 'failed', 'authorized'],
|
|
6547
|
+
type: 'string',
|
|
6548
|
+
},
|
|
6549
|
+
url: {
|
|
6550
|
+
description: 'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.',
|
|
6551
|
+
format: 'uri',
|
|
6552
|
+
type: 'string',
|
|
6553
|
+
},
|
|
6554
|
+
wait_for_device_creation: {
|
|
6555
|
+
description: 'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.',
|
|
6556
|
+
type: 'boolean',
|
|
6557
|
+
},
|
|
6558
|
+
workspace_id: {
|
|
6559
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.',
|
|
6560
|
+
format: 'uuid',
|
|
6561
|
+
type: 'string',
|
|
6562
|
+
},
|
|
6500
6563
|
},
|
|
6501
6564
|
required: [
|
|
6502
6565
|
'connect_webview_id',
|
|
@@ -6525,18 +6588,37 @@ export default {
|
|
|
6525
6588
|
connected_account: {
|
|
6526
6589
|
description: 'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.',
|
|
6527
6590
|
properties: {
|
|
6528
|
-
account_type: {
|
|
6529
|
-
|
|
6530
|
-
|
|
6531
|
-
|
|
6532
|
-
|
|
6591
|
+
account_type: {
|
|
6592
|
+
description: 'Type of connected account.',
|
|
6593
|
+
type: 'string',
|
|
6594
|
+
},
|
|
6595
|
+
account_type_display_name: {
|
|
6596
|
+
description: 'Display name for the connected account type.',
|
|
6597
|
+
type: 'string',
|
|
6598
|
+
},
|
|
6599
|
+
automatically_manage_new_devices: {
|
|
6600
|
+
description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
|
|
6601
|
+
type: 'boolean',
|
|
6602
|
+
},
|
|
6603
|
+
connected_account_id: {
|
|
6604
|
+
description: 'Unique identifier for the connected account.',
|
|
6605
|
+
format: 'uuid',
|
|
6606
|
+
type: 'string',
|
|
6607
|
+
},
|
|
6608
|
+
created_at: {
|
|
6609
|
+
description: 'Date and time at which the connected account was created.',
|
|
6610
|
+
format: 'date-time',
|
|
6611
|
+
type: 'string',
|
|
6612
|
+
},
|
|
6533
6613
|
custom_metadata: {
|
|
6534
6614
|
additionalProperties: {
|
|
6535
6615
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
6536
6616
|
},
|
|
6617
|
+
description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
|
|
6537
6618
|
type: 'object',
|
|
6538
6619
|
},
|
|
6539
6620
|
errors: {
|
|
6621
|
+
description: 'Errors associated with the connected account.',
|
|
6540
6622
|
items: {
|
|
6541
6623
|
discriminator: { propertyName: 'error_code' },
|
|
6542
6624
|
oneOf: [
|
|
@@ -6553,9 +6635,18 @@ export default {
|
|
|
6553
6635
|
enum: ['account_disconnected'],
|
|
6554
6636
|
type: 'string',
|
|
6555
6637
|
},
|
|
6556
|
-
is_bridge_error: {
|
|
6557
|
-
|
|
6558
|
-
|
|
6638
|
+
is_bridge_error: {
|
|
6639
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6640
|
+
type: 'boolean',
|
|
6641
|
+
},
|
|
6642
|
+
is_connected_account_error: {
|
|
6643
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6644
|
+
type: 'boolean',
|
|
6645
|
+
},
|
|
6646
|
+
message: {
|
|
6647
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6648
|
+
type: 'string',
|
|
6649
|
+
},
|
|
6559
6650
|
},
|
|
6560
6651
|
required: ['created_at', 'message', 'error_code'],
|
|
6561
6652
|
type: 'object',
|
|
@@ -6573,15 +6664,24 @@ export default {
|
|
|
6573
6664
|
enum: ['invalid_credentials'],
|
|
6574
6665
|
type: 'string',
|
|
6575
6666
|
},
|
|
6576
|
-
is_bridge_error: {
|
|
6577
|
-
|
|
6578
|
-
|
|
6667
|
+
is_bridge_error: {
|
|
6668
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6669
|
+
type: 'boolean',
|
|
6670
|
+
},
|
|
6671
|
+
is_connected_account_error: {
|
|
6672
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6673
|
+
type: 'boolean',
|
|
6674
|
+
},
|
|
6675
|
+
message: {
|
|
6676
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6677
|
+
type: 'string',
|
|
6678
|
+
},
|
|
6579
6679
|
},
|
|
6580
6680
|
required: ['created_at', 'message', 'error_code'],
|
|
6581
6681
|
type: 'object',
|
|
6582
6682
|
},
|
|
6583
6683
|
{
|
|
6584
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
6684
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
6585
6685
|
properties: {
|
|
6586
6686
|
created_at: {
|
|
6587
6687
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -6593,9 +6693,18 @@ export default {
|
|
|
6593
6693
|
enum: ['bridge_disconnected'],
|
|
6594
6694
|
type: 'string',
|
|
6595
6695
|
},
|
|
6596
|
-
is_bridge_error: {
|
|
6597
|
-
|
|
6598
|
-
|
|
6696
|
+
is_bridge_error: {
|
|
6697
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6698
|
+
type: 'boolean',
|
|
6699
|
+
},
|
|
6700
|
+
is_connected_account_error: {
|
|
6701
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6702
|
+
type: 'boolean',
|
|
6703
|
+
},
|
|
6704
|
+
message: {
|
|
6705
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6706
|
+
type: 'string',
|
|
6707
|
+
},
|
|
6599
6708
|
},
|
|
6600
6709
|
required: ['created_at', 'message', 'error_code'],
|
|
6601
6710
|
type: 'object',
|
|
@@ -6613,21 +6722,41 @@ export default {
|
|
|
6613
6722
|
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
6614
6723
|
type: 'string',
|
|
6615
6724
|
},
|
|
6616
|
-
is_bridge_error: {
|
|
6617
|
-
|
|
6618
|
-
|
|
6725
|
+
is_bridge_error: {
|
|
6726
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
6727
|
+
type: 'boolean',
|
|
6728
|
+
},
|
|
6729
|
+
is_connected_account_error: {
|
|
6730
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
6731
|
+
type: 'boolean',
|
|
6732
|
+
},
|
|
6733
|
+
message: {
|
|
6734
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
6735
|
+
type: 'string',
|
|
6736
|
+
},
|
|
6619
6737
|
salto_ks_metadata: {
|
|
6738
|
+
description: 'Salto KS metadata associated with the connected account that has an error.',
|
|
6620
6739
|
properties: {
|
|
6621
6740
|
sites: {
|
|
6741
|
+
description: 'Salto sites associated with the connected account that has an error.',
|
|
6622
6742
|
items: {
|
|
6743
|
+
description: 'Salto site associated with the connected account that has an error.',
|
|
6623
6744
|
properties: {
|
|
6624
|
-
site_id: {
|
|
6625
|
-
|
|
6745
|
+
site_id: {
|
|
6746
|
+
description: 'ID of a Salto site associated with the connected account that has an error.',
|
|
6747
|
+
type: 'string',
|
|
6748
|
+
},
|
|
6749
|
+
site_name: {
|
|
6750
|
+
description: 'Name of a Salto site associated with the connected account that has an error.',
|
|
6751
|
+
type: 'string',
|
|
6752
|
+
},
|
|
6626
6753
|
site_user_subscription_limit: {
|
|
6754
|
+
description: 'Subscription limit of site users for a Salto site associated with the connected account that has an error.',
|
|
6627
6755
|
minimum: 0,
|
|
6628
6756
|
type: 'integer',
|
|
6629
6757
|
},
|
|
6630
6758
|
subscribed_site_user_count: {
|
|
6759
|
+
description: 'Count of subscribed site users for a Salto site associated with the connected account that has an error.',
|
|
6631
6760
|
minimum: 0,
|
|
6632
6761
|
type: 'integer',
|
|
6633
6762
|
},
|
|
@@ -6660,29 +6789,49 @@ export default {
|
|
|
6660
6789
|
type: 'array',
|
|
6661
6790
|
},
|
|
6662
6791
|
user_identifier: {
|
|
6792
|
+
description: 'User identifier associated with the connected account.',
|
|
6663
6793
|
properties: {
|
|
6664
|
-
api_url: {
|
|
6665
|
-
|
|
6666
|
-
|
|
6667
|
-
|
|
6668
|
-
|
|
6794
|
+
api_url: {
|
|
6795
|
+
description: 'API URL for the user identifier associated with the connected account.',
|
|
6796
|
+
type: 'string',
|
|
6797
|
+
},
|
|
6798
|
+
email: {
|
|
6799
|
+
description: 'Email address of the user identifier associated with the connected account.',
|
|
6800
|
+
type: 'string',
|
|
6801
|
+
},
|
|
6802
|
+
exclusive: {
|
|
6803
|
+
description: 'Indicates whether the user identifier associated with the connected account is exclusive.',
|
|
6804
|
+
type: 'boolean',
|
|
6805
|
+
},
|
|
6806
|
+
phone: {
|
|
6807
|
+
description: 'Phone number of the user identifier associated with the connected account.',
|
|
6808
|
+
type: 'string',
|
|
6809
|
+
},
|
|
6810
|
+
username: {
|
|
6811
|
+
description: 'Username of the user identifier associated with the connected account.',
|
|
6812
|
+
type: 'string',
|
|
6813
|
+
},
|
|
6669
6814
|
},
|
|
6670
6815
|
type: 'object',
|
|
6671
6816
|
},
|
|
6672
6817
|
warnings: {
|
|
6818
|
+
description: 'Warnings associated with the connected account.',
|
|
6673
6819
|
items: {
|
|
6674
|
-
description: 'Warning associated with the
|
|
6820
|
+
description: 'Warning associated with the connected account.',
|
|
6675
6821
|
discriminator: { propertyName: 'warning_code' },
|
|
6676
6822
|
oneOf: [
|
|
6677
6823
|
{
|
|
6678
|
-
description: 'Scheduled downtime for account
|
|
6824
|
+
description: 'Scheduled downtime planned for the connected account.',
|
|
6679
6825
|
properties: {
|
|
6680
6826
|
created_at: {
|
|
6681
6827
|
description: 'Date and time at which Seam created the warning.',
|
|
6682
6828
|
format: 'date-time',
|
|
6683
6829
|
type: 'string',
|
|
6684
6830
|
},
|
|
6685
|
-
message: {
|
|
6831
|
+
message: {
|
|
6832
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
6833
|
+
type: 'string',
|
|
6834
|
+
},
|
|
6686
6835
|
warning_code: {
|
|
6687
6836
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6688
6837
|
enum: ['scheduled_maintenance_window'],
|
|
@@ -6693,14 +6842,17 @@ export default {
|
|
|
6693
6842
|
type: 'object',
|
|
6694
6843
|
},
|
|
6695
6844
|
{
|
|
6696
|
-
description: 'An unknown issue occurred while syncing the state of
|
|
6845
|
+
description: 'An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.',
|
|
6697
6846
|
properties: {
|
|
6698
6847
|
created_at: {
|
|
6699
6848
|
description: 'Date and time at which Seam created the warning.',
|
|
6700
6849
|
format: 'date-time',
|
|
6701
6850
|
type: 'string',
|
|
6702
6851
|
},
|
|
6703
|
-
message: {
|
|
6852
|
+
message: {
|
|
6853
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
6854
|
+
type: 'string',
|
|
6855
|
+
},
|
|
6704
6856
|
warning_code: {
|
|
6705
6857
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6706
6858
|
enum: ['unknown_issue_with_connected_account'],
|
|
@@ -6711,26 +6863,40 @@ export default {
|
|
|
6711
6863
|
type: 'object',
|
|
6712
6864
|
},
|
|
6713
6865
|
{
|
|
6714
|
-
description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users.
|
|
6866
|
+
description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.',
|
|
6715
6867
|
properties: {
|
|
6716
6868
|
created_at: {
|
|
6717
6869
|
description: 'Date and time at which Seam created the warning.',
|
|
6718
6870
|
format: 'date-time',
|
|
6719
6871
|
type: 'string',
|
|
6720
6872
|
},
|
|
6721
|
-
message: {
|
|
6873
|
+
message: {
|
|
6874
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
6875
|
+
type: 'string',
|
|
6876
|
+
},
|
|
6722
6877
|
salto_ks_metadata: {
|
|
6878
|
+
description: 'Salto KS metadata associated with the connected account that has a warning.',
|
|
6723
6879
|
properties: {
|
|
6724
6880
|
sites: {
|
|
6881
|
+
description: 'Salto sites associated with the connected account that has a warning.',
|
|
6725
6882
|
items: {
|
|
6883
|
+
description: 'Salto site associated with the connected account that has a warning.',
|
|
6726
6884
|
properties: {
|
|
6727
|
-
site_id: {
|
|
6728
|
-
|
|
6885
|
+
site_id: {
|
|
6886
|
+
description: 'ID of a Salto site associated with the connected account that has a warning.',
|
|
6887
|
+
type: 'string',
|
|
6888
|
+
},
|
|
6889
|
+
site_name: {
|
|
6890
|
+
description: 'Name of a Salto site associated with the connected account that has a warning.',
|
|
6891
|
+
type: 'string',
|
|
6892
|
+
},
|
|
6729
6893
|
site_user_subscription_limit: {
|
|
6894
|
+
description: 'Subscription limit of site users for a Salto site associated with the connected account that has a warning.',
|
|
6730
6895
|
minimum: 0,
|
|
6731
6896
|
type: 'integer',
|
|
6732
6897
|
},
|
|
6733
6898
|
subscribed_site_user_count: {
|
|
6899
|
+
description: 'Count of subscribed site users for a Salto site associated with the connected account that has a warning.',
|
|
6734
6900
|
minimum: 0,
|
|
6735
6901
|
type: 'integer',
|
|
6736
6902
|
},
|
|
@@ -6821,6 +6987,7 @@ export default {
|
|
|
6821
6987
|
additionalProperties: {
|
|
6822
6988
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
6823
6989
|
},
|
|
6990
|
+
description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
|
|
6824
6991
|
type: 'object',
|
|
6825
6992
|
},
|
|
6826
6993
|
device_id: {
|
|
@@ -7177,15 +7344,24 @@ export default {
|
|
|
7177
7344
|
enum: ['invalid_credentials'],
|
|
7178
7345
|
type: 'string',
|
|
7179
7346
|
},
|
|
7180
|
-
is_bridge_error: {
|
|
7181
|
-
|
|
7182
|
-
|
|
7347
|
+
is_bridge_error: {
|
|
7348
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
7349
|
+
type: 'boolean',
|
|
7350
|
+
},
|
|
7351
|
+
is_connected_account_error: {
|
|
7352
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
7353
|
+
type: 'boolean',
|
|
7354
|
+
},
|
|
7355
|
+
message: {
|
|
7356
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7357
|
+
type: 'string',
|
|
7358
|
+
},
|
|
7183
7359
|
},
|
|
7184
7360
|
required: ['created_at', 'message', 'error_code'],
|
|
7185
7361
|
type: 'object',
|
|
7186
7362
|
},
|
|
7187
7363
|
{
|
|
7188
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
7364
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
7189
7365
|
properties: {
|
|
7190
7366
|
created_at: {
|
|
7191
7367
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -7197,9 +7373,18 @@ export default {
|
|
|
7197
7373
|
enum: ['bridge_disconnected'],
|
|
7198
7374
|
type: 'string',
|
|
7199
7375
|
},
|
|
7200
|
-
is_bridge_error: {
|
|
7201
|
-
|
|
7202
|
-
|
|
7376
|
+
is_bridge_error: {
|
|
7377
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
7378
|
+
type: 'boolean',
|
|
7379
|
+
},
|
|
7380
|
+
is_connected_account_error: {
|
|
7381
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
7382
|
+
type: 'boolean',
|
|
7383
|
+
},
|
|
7384
|
+
message: {
|
|
7385
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7386
|
+
type: 'string',
|
|
7387
|
+
},
|
|
7203
7388
|
},
|
|
7204
7389
|
required: ['created_at', 'message', 'error_code'],
|
|
7205
7390
|
type: 'object',
|
|
@@ -15470,15 +15655,24 @@ export default {
|
|
|
15470
15655
|
enum: ['invalid_credentials'],
|
|
15471
15656
|
type: 'string',
|
|
15472
15657
|
},
|
|
15473
|
-
is_bridge_error: {
|
|
15474
|
-
|
|
15475
|
-
|
|
15658
|
+
is_bridge_error: {
|
|
15659
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
15660
|
+
type: 'boolean',
|
|
15661
|
+
},
|
|
15662
|
+
is_connected_account_error: {
|
|
15663
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
15664
|
+
type: 'boolean',
|
|
15665
|
+
},
|
|
15666
|
+
message: {
|
|
15667
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
15668
|
+
type: 'string',
|
|
15669
|
+
},
|
|
15476
15670
|
},
|
|
15477
15671
|
required: ['created_at', 'message', 'error_code'],
|
|
15478
15672
|
type: 'object',
|
|
15479
15673
|
},
|
|
15480
15674
|
{
|
|
15481
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
15675
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
15482
15676
|
properties: {
|
|
15483
15677
|
created_at: {
|
|
15484
15678
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -15490,9 +15684,18 @@ export default {
|
|
|
15490
15684
|
enum: ['bridge_disconnected'],
|
|
15491
15685
|
type: 'string',
|
|
15492
15686
|
},
|
|
15493
|
-
is_bridge_error: {
|
|
15494
|
-
|
|
15495
|
-
|
|
15687
|
+
is_bridge_error: {
|
|
15688
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
15689
|
+
type: 'boolean',
|
|
15690
|
+
},
|
|
15691
|
+
is_connected_account_error: {
|
|
15692
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
15693
|
+
type: 'boolean',
|
|
15694
|
+
},
|
|
15695
|
+
message: {
|
|
15696
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
15697
|
+
type: 'string',
|
|
15698
|
+
},
|
|
15496
15699
|
},
|
|
15497
15700
|
required: ['created_at', 'message', 'error_code'],
|
|
15498
15701
|
type: 'object',
|
|
@@ -17192,15 +17395,24 @@ export default {
|
|
|
17192
17395
|
enum: ['invalid_credentials'],
|
|
17193
17396
|
type: 'string',
|
|
17194
17397
|
},
|
|
17195
|
-
is_bridge_error: {
|
|
17196
|
-
|
|
17197
|
-
|
|
17398
|
+
is_bridge_error: {
|
|
17399
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
17400
|
+
type: 'boolean',
|
|
17401
|
+
},
|
|
17402
|
+
is_connected_account_error: {
|
|
17403
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
17404
|
+
type: 'boolean',
|
|
17405
|
+
},
|
|
17406
|
+
message: {
|
|
17407
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17408
|
+
type: 'string',
|
|
17409
|
+
},
|
|
17198
17410
|
},
|
|
17199
17411
|
required: ['created_at', 'message', 'error_code'],
|
|
17200
17412
|
type: 'object',
|
|
17201
17413
|
},
|
|
17202
17414
|
{
|
|
17203
|
-
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
17415
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
|
|
17204
17416
|
properties: {
|
|
17205
17417
|
created_at: {
|
|
17206
17418
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -17212,9 +17424,18 @@ export default {
|
|
|
17212
17424
|
enum: ['bridge_disconnected'],
|
|
17213
17425
|
type: 'string',
|
|
17214
17426
|
},
|
|
17215
|
-
is_bridge_error: {
|
|
17216
|
-
|
|
17217
|
-
|
|
17427
|
+
is_bridge_error: {
|
|
17428
|
+
description: 'Indicates whether the error is related to Seam Bridge.',
|
|
17429
|
+
type: 'boolean',
|
|
17430
|
+
},
|
|
17431
|
+
is_connected_account_error: {
|
|
17432
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
17433
|
+
type: 'boolean',
|
|
17434
|
+
},
|
|
17435
|
+
message: {
|
|
17436
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17437
|
+
type: 'string',
|
|
17438
|
+
},
|
|
17218
17439
|
},
|
|
17219
17440
|
required: ['created_at', 'message', 'error_code'],
|
|
17220
17441
|
type: 'object',
|
|
@@ -22633,13 +22854,22 @@ export default {
|
|
|
22633
22854
|
'application/json': {
|
|
22634
22855
|
schema: {
|
|
22635
22856
|
properties: {
|
|
22857
|
+
acs_system_id: {
|
|
22858
|
+
description: 'ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.',
|
|
22859
|
+
format: 'uuid',
|
|
22860
|
+
type: 'string',
|
|
22861
|
+
},
|
|
22636
22862
|
acs_user_id: {
|
|
22637
|
-
description: 'ID of the access system user that you want to delete.',
|
|
22863
|
+
description: 'ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id',
|
|
22864
|
+
format: 'uuid',
|
|
22865
|
+
type: 'string',
|
|
22866
|
+
},
|
|
22867
|
+
user_identity_id: {
|
|
22868
|
+
description: 'ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.',
|
|
22638
22869
|
format: 'uuid',
|
|
22639
22870
|
type: 'string',
|
|
22640
22871
|
},
|
|
22641
22872
|
},
|
|
22642
|
-
required: ['acs_user_id'],
|
|
22643
22873
|
type: 'object',
|
|
22644
22874
|
},
|
|
22645
22875
|
},
|
|
@@ -22683,13 +22913,22 @@ export default {
|
|
|
22683
22913
|
'application/json': {
|
|
22684
22914
|
schema: {
|
|
22685
22915
|
properties: {
|
|
22916
|
+
acs_system_id: {
|
|
22917
|
+
description: 'ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
22918
|
+
format: 'uuid',
|
|
22919
|
+
type: 'string',
|
|
22920
|
+
},
|
|
22686
22921
|
acs_user_id: {
|
|
22687
|
-
description: 'ID of the access system user that you want to get.',
|
|
22922
|
+
description: 'ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
22923
|
+
format: 'uuid',
|
|
22924
|
+
type: 'string',
|
|
22925
|
+
},
|
|
22926
|
+
user_identity_id: {
|
|
22927
|
+
description: 'ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.',
|
|
22688
22928
|
format: 'uuid',
|
|
22689
22929
|
type: 'string',
|
|
22690
22930
|
},
|
|
22691
22931
|
},
|
|
22692
|
-
required: ['acs_user_id'],
|
|
22693
22932
|
type: 'object',
|
|
22694
22933
|
},
|
|
22695
22934
|
},
|
|
@@ -22903,12 +23142,17 @@ export default {
|
|
|
22903
23142
|
type: 'string',
|
|
22904
23143
|
},
|
|
22905
23144
|
acs_user_id: {
|
|
22906
|
-
description: 'ID of the access system user that you want to remove from an access group.',
|
|
23145
|
+
description: 'ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
|
|
23146
|
+
format: 'uuid',
|
|
23147
|
+
type: 'string',
|
|
23148
|
+
},
|
|
23149
|
+
user_identity_id: {
|
|
23150
|
+
description: 'ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
|
|
22907
23151
|
format: 'uuid',
|
|
22908
23152
|
type: 'string',
|
|
22909
23153
|
},
|
|
22910
23154
|
},
|
|
22911
|
-
required: ['
|
|
23155
|
+
required: ['acs_access_group_id'],
|
|
22912
23156
|
type: 'object',
|
|
22913
23157
|
},
|
|
22914
23158
|
},
|
|
@@ -22952,13 +23196,22 @@ export default {
|
|
|
22952
23196
|
'application/json': {
|
|
22953
23197
|
schema: {
|
|
22954
23198
|
properties: {
|
|
23199
|
+
acs_system_id: {
|
|
23200
|
+
description: 'ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.',
|
|
23201
|
+
format: 'uuid',
|
|
23202
|
+
type: 'string',
|
|
23203
|
+
},
|
|
22955
23204
|
acs_user_id: {
|
|
22956
|
-
description: 'ID of the access system user for whom you want to revoke access.',
|
|
23205
|
+
description: 'ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.',
|
|
23206
|
+
format: 'uuid',
|
|
23207
|
+
type: 'string',
|
|
23208
|
+
},
|
|
23209
|
+
user_identity_id: {
|
|
23210
|
+
description: 'ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.',
|
|
22957
23211
|
format: 'uuid',
|
|
22958
23212
|
type: 'string',
|
|
22959
23213
|
},
|
|
22960
23214
|
},
|
|
22961
|
-
required: ['acs_user_id'],
|
|
22962
23215
|
type: 'object',
|
|
22963
23216
|
},
|
|
22964
23217
|
},
|
|
@@ -23002,13 +23255,22 @@ export default {
|
|
|
23002
23255
|
'application/json': {
|
|
23003
23256
|
schema: {
|
|
23004
23257
|
properties: {
|
|
23258
|
+
acs_system_id: {
|
|
23259
|
+
description: 'ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23260
|
+
format: 'uuid',
|
|
23261
|
+
type: 'string',
|
|
23262
|
+
},
|
|
23005
23263
|
acs_user_id: {
|
|
23006
|
-
description: 'ID of the access system user that you want to suspend.',
|
|
23264
|
+
description: 'ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23265
|
+
format: 'uuid',
|
|
23266
|
+
type: 'string',
|
|
23267
|
+
},
|
|
23268
|
+
user_identity_id: {
|
|
23269
|
+
description: 'ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23007
23270
|
format: 'uuid',
|
|
23008
23271
|
type: 'string',
|
|
23009
23272
|
},
|
|
23010
23273
|
},
|
|
23011
|
-
required: ['acs_user_id'],
|
|
23012
23274
|
type: 'object',
|
|
23013
23275
|
},
|
|
23014
23276
|
},
|
|
@@ -23187,13 +23449,22 @@ export default {
|
|
|
23187
23449
|
'application/json': {
|
|
23188
23450
|
schema: {
|
|
23189
23451
|
properties: {
|
|
23452
|
+
acs_system_id: {
|
|
23453
|
+
description: 'ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.',
|
|
23454
|
+
format: 'uuid',
|
|
23455
|
+
type: 'string',
|
|
23456
|
+
},
|
|
23190
23457
|
acs_user_id: {
|
|
23191
|
-
description: 'ID of the access system user that you want to unsuspend.',
|
|
23458
|
+
description: 'ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23459
|
+
format: 'uuid',
|
|
23460
|
+
type: 'string',
|
|
23461
|
+
},
|
|
23462
|
+
user_identity_id: {
|
|
23463
|
+
description: 'ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.',
|
|
23192
23464
|
format: 'uuid',
|
|
23193
23465
|
type: 'string',
|
|
23194
23466
|
},
|
|
23195
23467
|
},
|
|
23196
|
-
required: ['acs_user_id'],
|
|
23197
23468
|
type: 'object',
|
|
23198
23469
|
},
|
|
23199
23470
|
},
|
|
@@ -23255,8 +23526,13 @@ export default {
|
|
|
23255
23526
|
required: ['starts_at', 'ends_at'],
|
|
23256
23527
|
type: 'object',
|
|
23257
23528
|
},
|
|
23529
|
+
acs_system_id: {
|
|
23530
|
+
description: 'ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.',
|
|
23531
|
+
format: 'uuid',
|
|
23532
|
+
type: 'string',
|
|
23533
|
+
},
|
|
23258
23534
|
acs_user_id: {
|
|
23259
|
-
description: 'ID of the
|
|
23535
|
+
description: 'ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.',
|
|
23260
23536
|
format: 'uuid',
|
|
23261
23537
|
type: 'string',
|
|
23262
23538
|
},
|
|
@@ -23281,8 +23557,12 @@ export default {
|
|
|
23281
23557
|
description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
23282
23558
|
type: 'string',
|
|
23283
23559
|
},
|
|
23560
|
+
user_identity_id: {
|
|
23561
|
+
description: 'ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.',
|
|
23562
|
+
format: 'uuid',
|
|
23563
|
+
type: 'string',
|
|
23564
|
+
},
|
|
23284
23565
|
},
|
|
23285
|
-
required: ['acs_user_id'],
|
|
23286
23566
|
type: 'object',
|
|
23287
23567
|
},
|
|
23288
23568
|
},
|
|
@@ -23341,8 +23621,13 @@ export default {
|
|
|
23341
23621
|
required: ['starts_at', 'ends_at'],
|
|
23342
23622
|
type: 'object',
|
|
23343
23623
|
},
|
|
23624
|
+
acs_system_id: {
|
|
23625
|
+
description: 'ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.',
|
|
23626
|
+
format: 'uuid',
|
|
23627
|
+
type: 'string',
|
|
23628
|
+
},
|
|
23344
23629
|
acs_user_id: {
|
|
23345
|
-
description: 'ID of the
|
|
23630
|
+
description: 'ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.',
|
|
23346
23631
|
format: 'uuid',
|
|
23347
23632
|
type: 'string',
|
|
23348
23633
|
},
|
|
@@ -23367,8 +23652,12 @@ export default {
|
|
|
23367
23652
|
description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
23368
23653
|
type: 'string',
|
|
23369
23654
|
},
|
|
23655
|
+
user_identity_id: {
|
|
23656
|
+
description: 'ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.',
|
|
23657
|
+
format: 'uuid',
|
|
23658
|
+
type: 'string',
|
|
23659
|
+
},
|
|
23370
23660
|
},
|
|
23371
|
-
required: ['acs_user_id'],
|
|
23372
23661
|
type: 'object',
|
|
23373
23662
|
},
|
|
23374
23663
|
},
|