diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json
index c55edd3c6..067ad1562 100644
--- a/docs/api/_blueprint.json
+++ b/docs/api/_blueprint.json
@@ -6390,8 +6390,22 @@
},
{
"name": "acs_user_id",
- "description": "ID of the access system user to whom you want to grant access to an entrance.",
- "isRequired": true,
+ "description": "ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "description": "ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -7812,10 +7826,38 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
+ {
+ "name": "acs_system_id",
+ "description": "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the access system user that you want to delete.",
- "isRequired": true,
+ "description": "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "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.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -7939,10 +7981,38 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
+ {
+ "name": "acs_system_id",
+ "description": "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the access system user that you want to get.",
- "isRequired": true,
+ "description": "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "description": "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8313,10 +8383,38 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
+ {
+ "name": "acs_system_id",
+ "description": "ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the access system user for whom you want to list accessible entrances.",
- "isRequired": true,
+ "description": "ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "description": "ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8376,8 +8474,22 @@
},
{
"name": "acs_user_id",
- "description": "ID of the access system user that you want to remove from an access group.",
- "isRequired": true,
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "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.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8500,10 +8612,38 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
+ {
+ "name": "acs_system_id",
+ "description": "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the access system user for whom you want to revoke access.",
- "isRequired": true,
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "description": "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8546,10 +8686,38 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
+ {
+ "name": "acs_system_id",
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the access system user that you want to suspend.",
- "isRequired": true,
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "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.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8671,10 +8839,38 @@
"semanticMethod": "POST",
"preferredMethod": "POST",
"parameters": [
+ {
+ "name": "acs_system_id",
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the access system user that you want to unsuspend.",
- "isRequired": true,
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "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.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8841,10 +9037,24 @@
}
]
},
+ {
+ "name": "acs_system_id",
+ "description": "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
+ },
{
"name": "acs_user_id",
- "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
- "isRequired": true,
+ "description": "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
+ "isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -8924,6 +9134,20 @@
"hasDefault": false,
"format": "string",
"jsonType": "string"
+ },
+ {
+ "name": "user_identity_id",
+ "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.",
+ "isRequired": false,
+ "isDeprecated": false,
+ "deprecationMessage": "",
+ "isUndocumented": false,
+ "undocumentedMessage": "",
+ "isDraft": false,
+ "draftMessage": "",
+ "hasDefault": false,
+ "format": "id",
+ "jsonType": "string"
}
]
},
@@ -24566,7 +24790,7 @@
{
"name": "name",
"description": "User-friendly name to identify the thermostat daily program.",
- "isRequired": false,
+ "isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -24709,7 +24933,7 @@
{
"name": "name",
"description": "User-friendly name to identify the thermostat daily program that you want to update.",
- "isRequired": false,
+ "isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33361,7 +33585,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33374,7 +33598,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33387,7 +33611,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33443,7 +33667,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33456,7 +33680,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33469,7 +33693,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -33481,7 +33705,7 @@
"jsonType": "string"
}
],
- "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
+ "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
}
]
},
@@ -39925,7 +40149,7 @@
},
{
"name": "accepted_providers",
- "description": "",
+ "description": "List of accepted [provider keys](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -39952,7 +40176,7 @@
},
{
"name": "any_provider_allowed",
- "description": "",
+ "description": "Indicates whether any provider is allowed.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -39965,7 +40189,7 @@
},
{
"name": "authorized_at",
- "description": "",
+ "description": "Date and time at which the user authorized (through the Connect Webview) the management of their devices.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -39978,7 +40202,7 @@
},
{
"name": "automatically_manage_new_devices",
- "description": "",
+ "description": "Indicates whether Seam should [import all new devices](../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -39991,7 +40215,7 @@
},
{
"name": "connect_webview_id",
- "description": "",
+ "description": "ID of the Connect Webview.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40004,7 +40228,7 @@
},
{
"name": "connected_account_id",
- "description": "",
+ "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md) associated with the Connect Webview.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40017,7 +40241,7 @@
},
{
"name": "created_at",
- "description": "",
+ "description": "Date and time at which the Connect Webview was created.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40030,7 +40254,7 @@
},
{
"name": "custom_metadata",
- "description": "",
+ "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md), [connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md), or [device](../core-concepts/devices/adding-custom-metadata-to-a-device.md), enables you to store custom information, like customer details or internal IDs from your application.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40043,7 +40267,7 @@
},
{
"name": "custom_redirect_failure_url",
- "description": "",
+ "description": "URL to which the Connect Webview should redirect when an unexpected error occurs.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40056,7 +40280,7 @@
},
{
"name": "custom_redirect_url",
- "description": "",
+ "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.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40114,7 +40338,7 @@
},
{
"name": "login_successful",
- "description": "",
+ "description": "Indicates whether the user logged in successfully using the Connect Webview.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40127,7 +40351,7 @@
},
{
"name": "selected_provider",
- "description": "",
+ "description": "Selected provider of the Connect Webview, one of the [provider keys](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40140,7 +40364,7 @@
},
{
"name": "status",
- "description": "",
+ "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.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40185,7 +40409,7 @@
},
{
"name": "url",
- "description": "",
+ "description": "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40198,7 +40422,7 @@
},
{
"name": "wait_for_device_creation",
- "description": "",
+ "description": "Indicates whether Seam should [finish syncing all devices](../core-concepts/connect-webviews/customizing-connect-webviews.md#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40211,7 +40435,7 @@
},
{
"name": "workspace_id",
- "description": "",
+ "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the Connect Webview.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40239,7 +40463,7 @@
"properties": [
{
"name": "account_type",
- "description": "",
+ "description": "Type of connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40252,7 +40476,7 @@
},
{
"name": "account_type_display_name",
- "description": "",
+ "description": "Display name for the connected account type.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40265,7 +40489,7 @@
},
{
"name": "automatically_manage_new_devices",
- "description": "",
+ "description": "Indicates whether Seam should [import all new devices](../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40278,7 +40502,7 @@
},
{
"name": "connected_account_id",
- "description": "",
+ "description": "Unique identifier for the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40291,7 +40515,7 @@
},
{
"name": "created_at",
- "description": "",
+ "description": "Date and time at which the connected account was created.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40304,7 +40528,7 @@
},
{
"name": "custom_metadata",
- "description": "",
+ "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md), [connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md), or [device](../core-concepts/devices/adding-custom-metadata-to-a-device.md), enables you to store custom information, like customer details or internal IDs from your application.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40317,7 +40541,7 @@
},
{
"name": "errors",
- "description": "",
+ "description": "Errors associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40372,7 +40596,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40385,7 +40609,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40398,7 +40622,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40454,7 +40678,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40467,7 +40691,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40480,7 +40704,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40536,7 +40760,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40549,7 +40773,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40562,7 +40786,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40574,7 +40798,7 @@
"jsonType": "string"
}
],
- "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
+ "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
},
{
"properties": [
@@ -40618,7 +40842,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40631,7 +40855,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40644,7 +40868,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40657,7 +40881,7 @@
},
{
"name": "salto_ks_metadata",
- "description": "",
+ "description": "Salto KS metadata associated with the connected account that has an error.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40670,7 +40894,7 @@
"properties": [
{
"name": "sites",
- "description": "",
+ "description": "Salto sites associated with the connected account that has an error.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40684,7 +40908,7 @@
"itemProperties": [
{
"name": "site_id",
- "description": "",
+ "description": "ID of a Salto site associated with the connected account that has an error.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40697,7 +40921,7 @@
},
{
"name": "site_name",
- "description": "",
+ "description": "Name of a Salto site associated with the connected account that has an error.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40710,7 +40934,7 @@
},
{
"name": "site_user_subscription_limit",
- "description": "",
+ "description": "Subscription limit of site users for a Salto site associated with the connected account that has an error.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40723,7 +40947,7 @@
},
{
"name": "subscribed_site_user_count",
- "description": "",
+ "description": "Count of subscribed site users for a Salto site associated with the connected account that has an error.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40745,7 +40969,7 @@
},
{
"name": "user_identifier",
- "description": "",
+ "description": "User identifier associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40758,7 +40982,7 @@
"properties": [
{
"name": "api_url",
- "description": "",
+ "description": "API URL for the user identifier associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40771,7 +40995,7 @@
},
{
"name": "email",
- "description": "",
+ "description": "Email address of the user identifier associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40784,7 +41008,7 @@
},
{
"name": "exclusive",
- "description": "",
+ "description": "Indicates whether the user identifier associated with the connected account is exclusive.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40797,7 +41021,7 @@
},
{
"name": "phone",
- "description": "",
+ "description": "Phone number of the user identifier associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40810,7 +41034,7 @@
},
{
"name": "username",
- "description": "",
+ "description": "Username of the user identifier associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40825,7 +41049,7 @@
},
{
"name": "warnings",
- "description": "",
+ "description": "Warnings associated with the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40855,7 +41079,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40892,7 +41116,7 @@
]
}
],
- "description": "Scheduled downtime for account planned."
+ "description": "Scheduled downtime planned for the connected account."
},
{
"properties": [
@@ -40911,7 +41135,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40948,7 +41172,7 @@
]
}
],
- "description": "An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account."
+ "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."
},
{
"properties": [
@@ -40967,7 +41191,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40980,7 +41204,7 @@
},
{
"name": "salto_ks_metadata",
- "description": "",
+ "description": "Salto KS metadata associated with the connected account that has a warning.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -40993,7 +41217,7 @@
"properties": [
{
"name": "sites",
- "description": "",
+ "description": "Salto sites associated with the connected account that has a warning.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -41007,7 +41231,7 @@
"itemProperties": [
{
"name": "site_id",
- "description": "",
+ "description": "ID of a Salto site associated with the connected account that has a warning.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -41020,7 +41244,7 @@
},
{
"name": "site_name",
- "description": "",
+ "description": "Name of a Salto site associated with the connected account that has a warning.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -41033,7 +41257,7 @@
},
{
"name": "site_user_subscription_limit",
- "description": "",
+ "description": "Subscription limit of site users for a Salto site associated with the connected account that has a warning.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -41046,7 +41270,7 @@
},
{
"name": "subscribed_site_user_count",
- "description": "",
+ "description": "Count of subscribed site users for a Salto site associated with the connected account that has a warning.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -41087,7 +41311,7 @@
]
}
],
- "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this."
+ "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."
}
]
}
@@ -41353,7 +41577,7 @@
},
{
"name": "custom_metadata",
- "description": "",
+ "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md), [connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md), or [device](../core-concepts/devices/adding-custom-metadata-to-a-device.md), enables you to store custom information, like customer details or internal IDs from your application.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42755,7 +42979,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42768,7 +42992,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42781,7 +43005,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42837,7 +43061,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42850,7 +43074,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42863,7 +43087,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -42875,7 +43099,7 @@
"jsonType": "string"
}
],
- "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
+ "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
}
]
},
@@ -55965,7 +56189,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -55978,7 +56202,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -55991,7 +56215,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -56047,7 +56271,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -56060,7 +56284,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -56073,7 +56297,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -56085,7 +56309,7 @@
"jsonType": "string"
}
],
- "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
+ "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
}
]
},
@@ -61537,7 +61761,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -61550,7 +61774,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -61563,7 +61787,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -61619,7 +61843,7 @@
},
{
"name": "is_bridge_error",
- "description": "",
+ "description": "Indicates whether the error is related to Seam Bridge.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -61632,7 +61856,7 @@
},
{
"name": "is_connected_account_error",
- "description": "",
+ "description": "Indicates whether the error is related specifically to the connected account.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -61645,7 +61869,7 @@
},
{
"name": "message",
- "description": "",
+ "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
@@ -61657,7 +61881,7 @@
"jsonType": "string"
}
],
- "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
+ "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
}
]
},
diff --git a/docs/api/_report.md b/docs/api/_report.md
index 6b0e40439..abcb6e953 100644
--- a/docs/api/_report.md
+++ b/docs/api/_report.md
@@ -245,33 +245,8 @@ Items that are intentionally undocumented are not included in this section.
- `client_session.user_identity_ids`
- `client_session.workspace_id`
- `connect_webview.accepted_devices`
-- `connect_webview.accepted_providers`
- `connect_webview.any_device_allowed`
-- `connect_webview.any_provider_allowed`
-- `connect_webview.authorized_at`
-- `connect_webview.automatically_manage_new_devices`
-- `connect_webview.connect_webview_id`
-- `connect_webview.connected_account_id`
-- `connect_webview.created_at`
-- `connect_webview.custom_metadata`
-- `connect_webview.custom_redirect_failure_url`
-- `connect_webview.custom_redirect_url`
- `connect_webview.device_selection_mode`
-- `connect_webview.login_successful`
-- `connect_webview.selected_provider`
-- `connect_webview.status`
-- `connect_webview.url`
-- `connect_webview.wait_for_device_creation`
-- `connect_webview.workspace_id`
-- `connected_account.account_type`
-- `connected_account.account_type_display_name`
-- `connected_account.automatically_manage_new_devices`
-- `connected_account.connected_account_id`
-- `connected_account.created_at`
-- `connected_account.custom_metadata`
-- `connected_account.errors`
-- `connected_account.user_identifier`
-- `connected_account.warnings`
- `device.can_hvac_cool`
- `device.can_hvac_heat`
- `device.can_hvac_heat_cool`
@@ -283,7 +258,6 @@ Items that are intentionally undocumented are not included in this section.
- `device.can_simulate_disconnection`
- `device.can_simulate_removal`
- `device.can_turn_off_hvac`
-- `device.custom_metadata`
- `device_provider.can_hvac_cool`
- `device_provider.can_hvac_heat`
- `device_provider.can_hvac_heat_cool`
diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md
index 5380f4481..34bdc2f4d 100644
--- a/docs/api/access_codes/README.md
+++ b/docs/api/access_codes/README.md
@@ -1635,25 +1635,30 @@ Credentials provided were invalid.
**`is_bridge_error`** *Boolean*
+ Indicates whether the error is related to Seam Bridge.
+
---
**`is_connected_account_error`** *Boolean*
+ Indicates whether the error is related specifically to the connected account.
+
---
**`message`** *String*
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
bridge_disconnected
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), 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](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), 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](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
**`created_at`** *Datetime*
@@ -1679,18 +1684,24 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili
**`is_bridge_error`** *Boolean*
+ Indicates whether the error is related to Seam Bridge.
+
---
**`is_connected_account_error`** *Boolean*
+ Indicates whether the error is related specifically to the connected account.
+
---
**`message`** *String*
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
@@ -2482,8 +2493,7 @@ Credentials provided were invalid.
**`bridge_disconnected`**
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), 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](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), 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](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
---
diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md
index 66a3f00d3..42d1f63af 100644
--- a/docs/api/access_codes/unmanaged/README.md
+++ b/docs/api/access_codes/unmanaged/README.md
@@ -1621,25 +1621,30 @@ Credentials provided were invalid.
**`is_bridge_error`** *Boolean*
+ Indicates whether the error is related to Seam Bridge.
+
---
**`is_connected_account_error`** *Boolean*
+ Indicates whether the error is related specifically to the connected account.
+
---
**`message`** *String*
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
bridge_disconnected
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), 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](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), 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](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
**`created_at`** *Datetime*
@@ -1665,18 +1670,24 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
**`is_bridge_error`** *Boolean*
+ Indicates whether the error is related to Seam Bridge.
+
---
**`is_connected_account_error`** *Boolean*
+ Indicates whether the error is related specifically to the connected account.
+
---
**`message`** *String*
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
@@ -2392,8 +2403,7 @@ Credentials provided were invalid.
**`bridge_disconnected`**
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), 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](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), 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](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
---
diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md
index 69de48616..83e253d37 100644
--- a/docs/api/acs/entrances/grant_access.md
+++ b/docs/api/acs/entrances/grant_access.md
@@ -33,9 +33,15 @@ ID of the entrance to which you want to grant an access system user access.
---
-**`acs_user_id`** *String* (Required)
+**`acs_user_id`** *String*
-ID of the access system user to whom you want to grant access to an entrance.
+ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
---
diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md
index 8c966e274..605ce98c1 100644
--- a/docs/api/acs/users/delete.md
+++ b/docs/api/acs/users/delete.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
-ID of the access system user that you want to delete.
+ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
+
+---
+
+**`user_identity_id`** *String*
+
+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.
---
diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md
index 7367d5d32..dd29f4969 100644
--- a/docs/api/acs/users/get.md
+++ b/docs/api/acs/users/get.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
-ID of the access system user that you want to get.
+ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
---
diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md
index cefb818a0..fe008b6cc 100644
--- a/docs/api/acs/users/list_accessible_entrances.md
+++ b/docs/api/acs/users/list_accessible_entrances.md
@@ -28,9 +28,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
-ID of the access system user for whom you want to list accessible entrances.
+ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
---
diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md
index 7e8ffc4a9..38c17d994 100644
--- a/docs/api/acs/users/remove_from_access_group.md
+++ b/docs/api/acs/users/remove_from_access_group.md
@@ -33,9 +33,15 @@ ID of the access group from which you want to remove an access system user.
---
-**`acs_user_id`** *String* (Required)
+**`acs_user_id`** *String*
-ID of the access system user that you want to remove from an access group.
+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.
+
+---
+
+**`user_identity_id`** *String*
+
+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.
---
diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md
index 380a1f839..59f2d009b 100644
--- a/docs/api/acs/users/revoke_access_to_all_entrances.md
+++ b/docs/api/acs/users/revoke_access_to_all_entrances.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
-ID of the access system user for whom you want to revoke access.
+ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
---
diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md
index dd6f96dc4..6aff8d0c1 100644
--- a/docs/api/acs/users/suspend.md
+++ b/docs/api/acs/users/suspend.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
-ID of the access system user that you want to suspend.
+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.
+
+---
+
+**`acs_user_id`** *String*
+
+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.
+
+---
+
+**`user_identity_id`** *String*
+
+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.
---
diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md
index 244cf6433..dd5a8da0f 100644
--- a/docs/api/acs/users/unsuspend.md
+++ b/docs/api/acs/users/unsuspend.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
-ID of the access system user that you want to unsuspend.
+ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+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.
+
+---
+
+**`user_identity_id`** *String*
+
+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.
---
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md
index 1c2627692..8cd70d3c2 100644
--- a/docs/api/acs/users/update.md
+++ b/docs/api/acs/users/update.md
@@ -27,15 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
## Request Parameters
-**`acs_user_id`** *String* (Required)
+**`access_schedule`** *Object*
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
---
-**`access_schedule`** *Object*
+**`acs_system_id`** *String*
-`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
---
@@ -65,6 +71,12 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc
---
+**`user_identity_id`** *String*
+
+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.
+
+---
+
## Response
diff --git a/package-lock.json b/package-lock.json
index a71569366..60f3793d6 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -14,7 +14,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.43.2",
"@seamapi/smith": "^0.4.4",
- "@seamapi/types": "^1.402.0",
+ "@seamapi/types": "^1.404.2",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
"execa": "^9.3.1",
@@ -798,9 +798,9 @@
}
},
"node_modules/@seamapi/types": {
- "version": "1.402.0",
- "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.402.0.tgz",
- "integrity": "sha512-pcnjm9Bei7Av6hNzVJ0/za9RdhFALD2pCIirO/LQYjV2sG5GLd/dmfgz9BM0vS8sDCLMlmOMHh0JOUA9+TboBQ==",
+ "version": "1.404.2",
+ "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.404.2.tgz",
+ "integrity": "sha512-Y4o7hT4CNE/gAqDQ50wJzj6XtiO8enHws8yKv5Si0+lA+5Tr1jcgkW5SGyU5XVGljdxctKHif843phsheSUAjg==",
"license": "MIT",
"engines": {
"node": ">=18.12.0",
diff --git a/package.json b/package.json
index 9dfa5f590..a06ead082 100644
--- a/package.json
+++ b/package.json
@@ -34,7 +34,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.43.2",
"@seamapi/smith": "^0.4.4",
- "@seamapi/types": "^1.402.0",
+ "@seamapi/types": "^1.404.2",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
"execa": "^9.3.1",