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:

account_disconnected

Account is disconnected.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

account_disconnected

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.

invalid_credentials

Credentials provided were invalid.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

invalid_credentials

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, 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.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

bridge_disconnected

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.

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.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

salto_ks_subscription_limit_exceeded

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.

salto_ks_metadata Object

Salto KS metadata associated with the connected account that has an error.

Child Properties

sites List of Objects
Salto sites associated with the connected account that has an error.
site_id String
ID of a Salto site associated with the connected account that has an error.
site_name String
Name of a Salto site associated with the connected account that has an error.
site_user_subscription_limit Number
Subscription limit of site users for a Salto site associated with the connected account that has an error.
subscribed_site_user_count Number
Count of subscribed site users for a Salto site associated with the connected account that has an error.

user_identifier Object

User identifier associated with the connected account.

Child Properties

api_url String
API URL for the user identifier associated with the connected account.
email String
Email address of the user identifier associated with the connected account.
exclusive Boolean
Indicates whether the user identifier associated with the connected account is exclusive.
phone String
Phone number of the user identifier associated with the connected account.
username String
Username of the 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:

scheduled_maintenance_window

Scheduled downtime planned for the connected account.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

scheduled_maintenance_window

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.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

unknown_issue_with_connected_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.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

salto_ks_metadata Object

Salto KS metadata associated with the connected account that has a warning.

Child Properties

sites List of Objects
Salto sites associated with the connected account that has a warning.
site_id String
ID of a Salto site associated with the connected account that has a warning.
site_name String
Name of a Salto site associated with the connected account that has a warning.
site_user_subscription_limit Number
Subscription limit of site users for a Salto site associated with the connected account that has a warning.
subscribed_site_user_count Number
Count of subscribed site users for a Salto site associated with the connected account that has a warning.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

salto_ks_subscription_limit_almost_reached

Errors

account_disconnected

Account is disconnected.

invalid_credentials

Credentials provided were invalid.

bridge_disconnected

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.

Properties

connect_webview_id UUID

ID of the Connect Webview associated with the event.

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.connected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

connected_account.created

A connected account was created.

Properties

connect_webview_id UUID

ID of the Connect Webview associated with the event.

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.created

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

connected_account.successful_login

A connected account had a successful login using a Connect Webview.

Properties

connect_webview_id UUID

ID of the Connect Webview associated with the event.

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.successful_login

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

connected_account.disconnected

A connected account was disconnected.

Properties

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.disconnected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

connected_account.completed_first_sync

A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.

Properties

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.completed_first_sync

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

connected_account.deleted

A connected account was deleted.

Properties

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

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.

Properties

connected_account_id UUID

ID of the affected connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: connected_account.completed_first_sync_after_reconnection

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

Endpoints

/connected_accounts/delete

Deletes a specified connected account.

/connected_accounts/get

Returns a specified connected account.

/connected_accounts/list

Returns a list of all connected accounts.

/connected_accounts/sync

Request a connected account sync attempt for the specified connected_account_id.

/connected_accounts/update

Updates a connected account.

PreviousDelete a Connect Webview NextGet a Connected Account

Last updated 6 days ago

Was this helpful?