Connected Accounts
The connected_account Object
Represents a connected account. 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.
Properties
account_type
String
Type of connected account.
account_type_display_name
String
Display name for the connected account type.
automatically_manage_new_devices
Boolean
Indicates whether Seam should import all new devices for the connected account to make these devices available for use and management by the Seam API.
connected_account_id
UUID
Unique identifier for the connected account.
created_at
Datetime
Date and time at which the connected account was created.
custom_metadata
Record
Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.
errors
List of Objects
Errors associated with the connected account.
The specific structure of each object in this list depends on the value of its error_code
field.
Variants:
user_identifier
Object
User identifier associated with the connected account.
warnings
List of Objects
Warnings associated with the connected account.
The specific structure of each object in this list depends on the value of its warning_code
field.
Variants:
Errors
account_disconnected
Account is disconnected.
invalid_credentials
Credentials provided were invalid.
bridge_disconnected
Indicates that the Seam API cannot communicate with 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.
salto_ks_subscription_limit_exceeded
Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
Warnings
scheduled_maintenance_window
Scheduled downtime planned for the connected account.
unknown_issue_with_connected_account
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.
salto_ks_subscription_limit_almost_reached
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.
Events
connected_account.connected
A connected account was connected for the first time or was reconnected after being disconnected.
connected_account.created
A connected account was created.
connected_account.successful_login
A connected account had a successful login using a Connect Webview.
connected_account.disconnected
A connected account was disconnected.
connected_account.completed_first_sync
A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
connected_account.deleted
A connected account was deleted.
connected_account.completed_first_sync_after_reconnection
A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
Endpoints
Deletes a specified connected account.
Returns a specified connected account.
Returns a list of all connected accounts.
Request a connected account sync attempt for the specified connected_account_id.
Updates a connected account.
Last updated
Was this helpful?