+| Property | Description |
|---|
+access_code_id UUID |
+
+Unique identifier for the access code.
+
+
+ |
+
+code String |
+
+Code used for access. Typically, a numeric or alphanumeric string.
+
+
+ |
+
+common_code_key String |
+
+Unique identifier for a group of access codes that share the same code.
+
+
+ |
+
+created_at Datetime |
+
+Date and time at which the access code was created.
+
+
+ |
+
+device_id UUID |
+
+Unique identifier for the device associated with the access code.
+
+
+ |
+
+ends_at Datetime |
+
+Date and time after which the time-bound access code becomes inactive.
+
+
+ |
+
+errors List of Objects |
+
+Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+ |
+
+is_backup Boolean |
+
+Indicates whether the access code is a backup code.
+
+
+ |
+
+is_backup_access_code_available Boolean |
+
+Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
+
+
+ |
+
+is_external_modification_allowed Boolean |
+
+Indicates whether changes to the access code from external sources are permitted.
+
+
+ |
+
+is_managed Boolean |
+
+Indicates whether Seam manages the access code.
+
+
+ |
+
+is_offline_access_code Boolean |
+
+Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
+
+
+ |
+
+is_one_time_use Boolean |
+
+Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.
+
+
+ |
+
+is_scheduled_on_device Boolean |
+
+Indicates whether the code is set on the device according to a preconfigured schedule.
+
+
+ |
+
+is_waiting_for_code_assignment Boolean |
+
+Indicates whether the access code is waiting for a code assignment.
+
+
+ |
+
+name String |
+
+Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+
+
+ |
+
+pulled_backup_access_code_id UUID |
+
+Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
+
+
+ |
+
+starts_at Datetime |
+
+Date and time at which the time-bound access code becomes active.
+
+
+ |
+
+status Enum |
+
+Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+
+
+
+Enum values
+
+- `setting`
+- `set`
+- `unset`
+- `removing`
+- `unknown`
+
+
+
+ |
+
+type Enum |
+
+Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.
+
+
+
+Enum values
+
+- `time_bound`
+- `ongoing`
+
+
+
+ |
+
+warnings List of Objects |
+
+Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+ |
+
+
+
+## Errors
+
+
+| Error | Description |
|---|
+smartthings_failed_to_set_access_code |
+
+Failed to set code on SmartThings device. |
+
+smartthings_failed_to_set_after_multiple_retries |
+
+Failed to set code after multiple retries. |
+
+smartthings_no_free_slots_available |
+
+No free slots available on the device. |
+
+failed_to_set_on_device |
+
+Failed to set code on device. |
+
+failed_to_remove_from_device |
+
+Failed to remove code from device. |
+
+duplicate_code_on_device |
+
+Duplicate access code detected on device. |
+
+duplicate_code_attempt_prevented |
+
+An attempt to modify this access code was prevented. |
+
+igloohome_bridge_too_many_pending_jobs |
+
+Igloohome bridge has too many pending jobs in the queue. |
+
+igloohome_bridge_offline |
+
+Igloohome bridge is offline. |
+
+igloohome_offline_access_code_no_variance_available |
+
+Lock has reached maximum amount of codes. |
+
+kwikset_unable_to_confirm_code |
+
+Unable to confirm that the access code is set on Kwikset device. |
+
+kwikset_unable_to_confirm_deletion |
+
+Unable to confirm the deletion of the access code on Kwikset device. |
+
+code_modified_external_to_seam |
+
+Code was modified or removed externally after Seam successfully set it on the device. |
+
+august_lock_invalid_code_length |
+
+Invalid code length for August lock. |
+
+august_device_programming_delay |
+
+Access code has not yet been fully moved to the device. |
+
+august_device_slots_full |
+
+All access code slots on the device are full. |
+
+august_lock_missing_keypad |
+
+August lock is missing a keypad. |
+
+august_lock_temporarily_offline |
+
+August lock is temporarily offline. |
+
+salto_ks_user_not_subscribed |
+
+Salto site user is not subscribed. |
+
+hubitat_device_programming_delay |
+
+Access code has not yet been fully moved to the device. |
+
+hubitat_no_free_positions_available |
+
+No free positions available on the device. |
+
+wyze_duplicate_code_name |
+
+Duplicate access code name detected. |
+
+wyze_potential_duplicate_code |
+
+Potential duplicate access code detected. |
+
+dormakaba_oracode_no_valid_user_level |
+
+No valid user level for Oracode. |
+
+account_disconnected |
+
+Account is disconnected |
+
+salto_ks_subscription_limit_exceeded |
+
+Salto site user limit reached. |
+
+device_offline |
+
+Device is offline |
+
+device_removed |
+
+Device has been removed |
+
+hub_disconnected |
+
+Hub is disconnected |
+
+device_disconnected |
+
+Device is disconnected |
+
+empty_backup_access_code_pool |
+
+The backup access code pool is empty. |
+
+august_lock_not_authorized |
+
+User is not authorized to use the August Lock. |
+
+august_lock_missing_bridge |
+
+Lock is not connected to the Seam Bridge. |
+
+ttlock_lock_not_paired_to_gateway |
+
+Lock is not paired with a Gateway. |
+
+missing_device_credentials |
+
+Missing device credentials. |
+
+auxiliary_heat_running |
+
+The auxiliary heat is running. |
+
+subscription_required |
+
+Subscription required to connect. |
+
+invalid_credentials |
+
+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). |
+
+
+
+## Warnings
+
+
+| Warning | Description |
|---|
+smartthings_failed_to_set_access_code |
+
+Failed to set code on SmartThings device. |
+
+schlage_detected_duplicate |
+
+Duplicate access code detected. |
+
+schlage_creation_outage |
+
+Received an error when attempting to create this code. |
+
+code_modified_external_to_seam |
+
+Code was modified or removed externally after Seam successfully set it on the device. |
+
+delay_in_setting_on_device |
+
+Delay in setting code on device. |
+
+delay_in_removing_from_device |
+
+Delay in removing code from device. |
+
+third_party_integration_detected |
+
+Third-party integration detected that may cause access codes to fail. |
+
+august_device_programming_delay |
+
+Access code has not yet been fully moved to the device. |
+
+august_lock_temporarily_offline |
+
+August lock is temporarily offline. |
+
+igloo_algopin_must_be_used_within_24_hours |
+
+Algopins must be used within 24 hours. |
+
+management_transferred |
+
+Management was transferred to another workspace. |
+
+kwikset_unable_to_confirm_code |
+
+Unable to confirm that the access code is set on Kwikset device. |
+
+
+
+## Events
+
+
+| Event | Description |
|---|
+access_code.created |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.changed |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.scheduled_on_device |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- code String
+
+ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.set_on_device |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- code String
+
+ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.removed_from_device |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.delay_in_setting_on_device |
+
+There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.failed_to_set_on_device |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.deleted |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- code String
+
+ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.delay_in_removing_from_device |
+
+There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.failed_to_remove_from_device |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.modified_external_to_seam |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.deleted_external_to_seam |
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.backup_access_code_pulled |
+
+A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- backup_access_code_id String
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.unmanaged.converted_to_managed |
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.unmanaged.failed_to_convert_to_managed |
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.unmanaged.created |
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+access_code.unmanaged.removed |
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+
+- event_type String
+
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+
+ |
+
+
+## Endpoints
+
+
+| Endpoint | Description |
|---|
+
+/access_codes/create |
+
+Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). |
+
+
+/access_codes/create_multiple |
+
+Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. |
+
+
+/access_codes/delete |
+
+Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). |
+
+
+/access_codes/get |
+
+Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). |
+
+
+/access_codes/list |
+
+Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). |
+
+
+/access_codes/pull_backup_access_code |
+
+Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). |
+
+
+/access_codes/update |
+
+Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). |
+
+
+/access_codes/update_multiple |
+
+Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. |
+
+
diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md
new file mode 100644
index 000000000..326638f7a
--- /dev/null
+++ b/docs/api/access_codes/create.md
@@ -0,0 +1,126 @@
+# Create an Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/create ⇒ { access_code }
+```
+{% endtab %}
+{% endtabs %}
+
+
+| Parameter | Description |
|---|
+device_id String (Required) |
+
+
+ID of the device for which to create the new access code.
+ |
+allow_external_modification Boolean |
+
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+ |
+attempt_for_offline_device Boolean |
+
+ |
+code String |
+
+
+Code to be used for access.
+ |
+common_code_key String |
+
+
+Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).
+ |
+ends_at String |
+
+
+Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+ |
+is_external_modification_allowed Boolean |
+
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+ |
+is_offline_access_code Boolean |
+
+
+Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
+ |
+is_one_time_use Boolean |
+
+
+Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+ |
+max_time_rounding String |
+
+
+Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+ |
+name String |
+
+
+Name of the new access code.
+ |
+prefer_native_scheduling Boolean |
+
+
+Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+ |
+preferred_code_length Number |
+
+
+Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+ |
+starts_at String |
+
+
+Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+use_backup_access_code_pool Boolean |
+
+
+Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md).
+ |
+use_offline_access_code Boolean |
+
+ |
+
+
+## Response
+
+[access\_code](./)
+
+**`CREATE_ACCESS_CODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md
new file mode 100644
index 000000000..42dfcdfa1
--- /dev/null
+++ b/docs/api/access_codes/create_multiple.md
@@ -0,0 +1,130 @@
+# Create Multiple Linked Access Codes
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
+
+Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
+
+If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.
+
+If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
+
+See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
+```
+{% endtab %}
+{% endtabs %}
+
+
+| Parameter | Description |
|---|
+device_ids Array of UUIDs (Required) |
+
+
+IDs of the devices for which to create the new access codes.
+ |
+allow_external_modification Boolean |
+
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+ |
+attempt_for_offline_device Boolean |
+
+ |
+behavior_when_code_cannot_be_shared String |
+
+
+Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.
+ |
+code String |
+
+
+Code to be used for access.
+ |
+ends_at String |
+
+
+Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+ |
+is_external_modification_allowed Boolean |
+
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+ |
+is_offline_access_code Boolean |
+
+
+Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
+ |
+is_one_time_use Boolean |
+
+
+Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+ |
+max_time_rounding String |
+
+
+Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+ |
+name String |
+
+
+Name of the new access code.
+ |
+prefer_native_scheduling Boolean |
+
+
+Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+ |
+preferred_code_length Number |
+
+
+Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+ |
+starts_at String |
+
+
+Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+use_backup_access_code_pool Boolean |
+
+
+Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md).
+ |
+use_offline_access_code Boolean |
+
+ |
+
+
+## Response
+
+Array of [access\_codes](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md
new file mode 100644
index 000000000..dcd73cadf
--- /dev/null
+++ b/docs/api/access_codes/delete.md
@@ -0,0 +1,47 @@
+# Delete an Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/delete ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+| Property | Description |
|---|
+access_code_id UUID |
+
+Unique identifier for the access code.
+
+
+ |
+
+code String |
+
+Code used for access. Typically, a numeric or alphanumeric string.
+
+
+ |
+
+created_at Datetime |
+
+Date and time at which the access code was created.
+
+
+ |
+
+device_id UUID |
+
+Unique identifier for the device associated with the access code.
+
+
+ |
+
+ends_at Datetime |
+
+Date and time after which the time-bound access code becomes inactive.
+
+
+ |
+
+errors List of Objects |
+
+Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+ |
+
+is_managed Boolean |
+
+Indicates that Seam does not manage the access code.
+
+
+ |
+
+name String |
+
+Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+
+
+ |
+
+starts_at Datetime |
+
+Date and time at which the time-bound access code becomes active.
+
+
+ |
+
+status String |
+
+Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.
+
+
+ |
+
+type Enum |
+
+Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.
+
+
+
+Enum values
+
+- `time_bound`
+- `ongoing`
+
+
+
+ |
+
+warnings List of Objects |
+
+Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+ |
+
+
+
+## Errors
+
+
+| Error | Description |
|---|
+smartthings_failed_to_set_access_code |
+
+Failed to set code on SmartThings device. |
+
+smartthings_failed_to_set_after_multiple_retries |
+
+Failed to set code after multiple retries. |
+
+smartthings_no_free_slots_available |
+
+No free slots available on the device. |
+
+failed_to_set_on_device |
+
+Failed to set code on device. |
+
+failed_to_remove_from_device |
+
+Failed to remove code from device. |
+
+duplicate_code_on_device |
+
+Duplicate access code detected on device. |
+
+duplicate_code_attempt_prevented |
+
+An attempt to modify this access code was prevented. |
+
+igloohome_bridge_too_many_pending_jobs |
+
+Igloohome bridge has too many pending jobs in the queue. |
+
+igloohome_bridge_offline |
+
+Igloohome bridge is offline. |
+
+igloohome_offline_access_code_no_variance_available |
+
+Lock has reached maximum amount of codes. |
+
+kwikset_unable_to_confirm_code |
+
+Unable to confirm that the access code is set on Kwikset device. |
+
+kwikset_unable_to_confirm_deletion |
+
+Unable to confirm the deletion of the access code on Kwikset device. |
+
+code_modified_external_to_seam |
+
+Code was modified or removed externally after Seam successfully set it on the device. |
+
+august_lock_invalid_code_length |
+
+Invalid code length for August lock. |
+
+august_device_programming_delay |
+
+Access code has not yet been fully moved to the device. |
+
+august_device_slots_full |
+
+All access code slots on the device are full. |
+
+august_lock_missing_keypad |
+
+August lock is missing a keypad. |
+
+august_lock_temporarily_offline |
+
+August lock is temporarily offline. |
+
+salto_ks_user_not_subscribed |
+
+Salto site user is not subscribed. |
+
+hubitat_device_programming_delay |
+
+Access code has not yet been fully moved to the device. |
+
+hubitat_no_free_positions_available |
+
+No free positions available on the device. |
+
+wyze_duplicate_code_name |
+
+Duplicate access code name detected. |
+
+wyze_potential_duplicate_code |
+
+Potential duplicate access code detected. |
+
+dormakaba_oracode_no_valid_user_level |
+
+No valid user level for Oracode. |
+
+account_disconnected |
+
+Account is disconnected |
+
+salto_ks_subscription_limit_exceeded |
+
+Salto site user limit reached. |
+
+device_offline |
+
+Device is offline |
+
+device_removed |
+
+Device has been removed |
+
+hub_disconnected |
+
+Hub is disconnected |
+
+device_disconnected |
+
+Device is disconnected |
+
+empty_backup_access_code_pool |
+
+The backup access code pool is empty. |
+
+august_lock_not_authorized |
+
+User is not authorized to use the August Lock. |
+
+august_lock_missing_bridge |
+
+Lock is not connected to the Seam Bridge. |
+
+ttlock_lock_not_paired_to_gateway |
+
+Lock is not paired with a Gateway. |
+
+missing_device_credentials |
+
+Missing device credentials. |
+
+auxiliary_heat_running |
+
+The auxiliary heat is running. |
+
+subscription_required |
+
+Subscription required to connect. |
+
+invalid_credentials |
+
+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). |
+
+
+
+## Warnings
+
+
+| Warning | Description |
|---|
+smartthings_failed_to_set_access_code |
+
+Failed to set code on SmartThings device. |
+
+schlage_detected_duplicate |
+
+Duplicate access code detected. |
+
+schlage_creation_outage |
+
+Received an error when attempting to create this code. |
+
+code_modified_external_to_seam |
+
+Code was modified or removed externally after Seam successfully set it on the device. |
+
+delay_in_setting_on_device |
+
+Delay in setting code on device. |
+
+delay_in_removing_from_device |
+
+Delay in removing code from device. |
+
+third_party_integration_detected |
+
+Third-party integration detected that may cause access codes to fail. |
+
+august_device_programming_delay |
+
+Access code has not yet been fully moved to the device. |
+
+august_lock_temporarily_offline |
+
+August lock is temporarily offline. |
+
+igloo_algopin_must_be_used_within_24_hours |
+
+Algopins must be used within 24 hours. |
+
+management_transferred |
+
+Management was transferred to another workspace. |
+
+kwikset_unable_to_confirm_code |
+
+Unable to confirm that the access code is set on Kwikset device. |
+
+
+
+
+## Endpoints
+
+
+| Parameter | Description |
|---|
+access_code_id String (Required) |
+
+
+ID of the access code that you want to update.
+ |
+allow_external_modification Boolean |
+
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+ |
+attempt_for_offline_device Boolean |
+
+ |
+code String |
+
+
+Code to be used for access.
+ |
+device_id String |
+
+
+ID of the device containing the access code that you want to update.
+ |
+ends_at String |
+
+
+Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+ |
+is_external_modification_allowed Boolean |
+
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+ |
+is_managed Boolean |
+
+
+Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.
+ |
+is_offline_access_code Boolean |
+
+
+Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
+ |
+is_one_time_use Boolean |
+
+
+Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+ |
+max_time_rounding String |
+
+
+Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+ |
+name String |
+
+
+Name of the new access code.
+ |
+prefer_native_scheduling Boolean |
+
+
+Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+ |
+preferred_code_length Number |
+
+
+Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+ |
+starts_at String |
+
+
+Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+type String |
+
+
+Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
+ |
+use_backup_access_code_pool Boolean |
+
+
+Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md).
+ |
+use_offline_access_code Boolean |
+
+ |
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md
new file mode 100644
index 000000000..9c5119d95
--- /dev/null
+++ b/docs/api/access_codes/update_multiple.md
@@ -0,0 +1,61 @@
+# Update Multiple Linked Access Codes
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
+
+Specify the `common_code_key` to identify the set of access codes that you want to update.
+
+See also [Update Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md#update-linked-access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PATCH /access_codes/update_multiple ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+| Property | Description |
|---|
+access_group_type Enum |
+
{% hint style="warning" %}
**Deprecated**. Use `external_type`.
{% endhint %}
-Format: `Enum`
+
+
+Enum values
-Possible enum values:
- `pti_unit`
- `pti_access_level`
- `salto_ks_access_group`
- `brivo_group`
- `salto_space_group`
- `dormakaba_community_access_group`
+
----
-### `access_group_type_display_name`
+ |
+access_group_type_display_name String |
+
{% hint style="warning" %}
**Deprecated**. Use `external_type_display_name`.
{% endhint %}
-Format: `String`
-
----
-
-### `acs_access_group_id`
-Format: `UUID`
+ |
+acs_access_group_id UUID |
+
ID of the access group.
----
-
-### `acs_system_id`
-Format: `UUID`
+ |
+acs_system_id UUID |
+
ID of the access control system that contains the access group.
----
-
-### `created_at`
-Format: `Datetime`
+ |
+created_at Datetime |
+
Date and time at which the access group was created.
----
-### `display_name`
+ |
-Format: `String`
+display_name String |
+
----
+ |
-### `external_type`
+external_type Enum |
+
+Brand-specific terminology for the access group type.
-Format: `Enum`
+
-Brand-specific terminology for the access group type.
+Enum values
-Possible enum values:
- `pti_unit`
- `pti_access_level`
- `salto_ks_access_group`
- `brivo_group`
- `salto_space_group`
- `dormakaba_community_access_group`
+
----
-
-### `external_type_display_name`
-Format: `String`
+ |
+external_type_display_name String |
+
Display name that corresponds to the brand-specific terminology for the access group type.
----
-### `is_managed`
+ |
-Format: `Boolean`
+is_managed Boolean |
+
----
+ |
-### `name`
+name String |
+
+Name of the access group.
-Format: `String`
-Name of the access group.
+ |
----
+warnings List of Objects |
+
+Warnings associated with the `acs_access_group`.
-### `warnings`
+
-Format: `List`
+Child Object Properties
-Item format: `Object`
+- created_at Datetime
-Warnings associated with the `acs_access_group`.
+ Date and time at which Seam created the warning.
-
-created_at Format: Datetime
-Date and time at which Seam created the warning.
-
-
+- message String
-message Format: String
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
-warning_code Format: String
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+- warning_code String
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+
----
-### `workspace_id`
-Format: `UUID`
+ |
+workspace_id UUID |
+
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group.
----
-## Endpoints
+ |
-### [`/acs/access_groups/add_user`](./add_user.md)
+
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/get`](./get.md)
+## Events
-Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/list`](./list.md)
+
+| Property | Description |
|---|
+access_method Enum |
+
+Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-Format: `Enum`
+
-Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
+Enum values
-Possible enum values:
- `code`
- `card`
- `mobile_key`
+
----
-
-### `acs_credential_id`
-Format: `UUID`
+ |
+acs_credential_id UUID |
+
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-### `acs_credential_pool_id`
+ |
-Format: `UUID`
+acs_credential_pool_id UUID |
+
----
-
-### `acs_system_id`
-
-Format: `UUID`
+ |
+acs_system_id UUID |
+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-
-### `acs_user_id`
-Format: `UUID`
+ |
+acs_user_id UUID |
+
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
----
-
-### `assa_abloy_vostio_metadata`
-Format: `Object`
+ |
+assa_abloy_vostio_metadata Object |
+
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-door_names Format: List Item format: String
-
-
+Child Properties
-endpoint_id Format: String
-
-
+- door_names List of Strings
-key_id Format: String
-
-
-key_issuing_request_id Format: String
-
-
-override_guest_acs_entrance_ids Format: List Item format: String
-
----
+- endpoint_id String
-### `card_number`
-Format: `String`
-Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+- key_id String
----
-### `code`
-Format: `String`
+- key_issuing_request_id String
-Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-### `created_at`
+- override_guest_acs_entrance_ids List of Strings
-Format: `Datetime`
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
----
-### `display_name`
+ |
-Format: `String`
+card_number String |
+
+Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
----
+ |
-### `ends_at`
+code String |
+
+Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-Format: `String`
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+ |
+
+created_at Datetime |
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
----
-### `errors`
+ |
+
+display_name String |
+
+Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-Format: `List`
-Item format: `Object`
+ |
+ends_at String |
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
+
+ |
+
+errors List of Objects |
+
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-error_code Format: String
-
-
+Child Object Properties
+
+- error_code String
+
+
+
+- message String
+
-message Format: String
----
-### `external_type`
-Format: `Enum`
+ |
+external_type Enum |
+
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-Possible enum values:
+
+
+Enum values
+
- `pti_card`
- `brivo_credential`
- `hid_credential`
@@ -151,365 +200,442 @@ Possible enum values:
- `salto_ks_credential`
- `assa_abloy_vostio_key`
- `salto_space_key`
+
----
-
-### `external_type_display_name`
-Format: `String`
+ |
+external_type_display_name String |
+
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
----
-
-### `is_issued`
-Format: `Boolean`
+ |
+is_issued Boolean |
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
----
-
-### `is_latest_desired_state_synced_with_provider`
-Format: `Boolean`
+ |
+is_latest_desired_state_synced_with_provider Boolean |
+
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
----
-
-### `is_managed`
-Format: `Boolean`
+ |
----
-
-### `is_multi_phone_sync_credential`
+is_managed Boolean |
+
-Format: `Boolean`
+ |
+is_multi_phone_sync_credential Boolean |
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
----
-### `is_one_time_use`
-
-Format: `Boolean`
+ |
+is_one_time_use Boolean |
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
----
-### `issued_at`
-
-Format: `Datetime`
+ |
+issued_at Datetime |
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
----
-
-### `latest_desired_state_synced_with_provider_at`
-Format: `Datetime`
+ |
+latest_desired_state_synced_with_provider_at Datetime |
+
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
----
-### `parent_acs_credential_id`
-
-Format: `UUID`
+ |
+parent_acs_credential_id UUID |
+
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-
-### `starts_at`
-Format: `String`
+ |
+starts_at String |
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
----
-
-### `visionline_metadata`
-Format: `Object`
+ |
+visionline_metadata Object |
+
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-auto_join Format: Boolean
-
-
+Child Properties
-card_function_type Format: Enum
+- auto_join Boolean
-Possible enum values:
-- `guest`
-- `staff`
-
-
-card_id Format: String
-
-
-common_acs_entrance_ids Format: List Item format: UUID
-
-
+- card_function_type Enum
-credential_id Format: String
-
-
-guest_acs_entrance_ids Format: List Item format: UUID
-
-is_valid Format: Boolean
-
-
+Enum values:
-joiner_acs_credential_ids Format: List Item format: UUID
+ - `guest`
+ - `staff`
----
-### [`warnings`](./#warnings-1)
-Format: `List`
-Item format: `Object`
+- card_id String
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-### `workspace_id`
+- common_acs_entrance_ids List of UUIDs
+
+
+
+- credential_id String
+
-Format: `UUID`
+- guest_acs_entrance_ids List of UUIDs
+
+
+
+- is_valid Boolean
+
+
+
+- joiner_acs_credential_ids List of UUIDs
+
+
+
+
+
+ |
+
+warnings List of Objects |
+
+Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+ |
+
+workspace_id UUID |
+
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
+
+ |
+
+
## Warnings
-### `waiting_to_be_issued`
+
+| Parameter | Description |
|---|
+access_method String (Required) |
+
+
+Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.
+ |
+acs_user_id String (Required) |
+
+
+ID of the ACS user to whom the new credential belongs.
+ |
+allowed_acs_entrance_ids Array of UUIDs |
+
+
+Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access.
+ |
+assa_abloy_vostio_metadata Object |
+
+
+Vostio-specific metadata for the new credential.
+ |
+code String |
+
+
+Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md).
+ |
+credential_manager_acs_system_id String |
+
+
+ACS system ID of the credential manager for the new credential.
+ |
+ends_at String |
+
+
+Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+ |
+is_multi_phone_sync_credential Boolean |
+
+
+Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+ |
+salto_space_metadata Object |
+
+
+Salto Space-specific metadata for the new credential.
+ |
+starts_at String |
+
+
+Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+visionline_metadata Object |
+
+
+Visionline-specific metadata for the new credential.
+ |
+
+
+## Response
+
+[acs\_credential](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_credential
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a credential for an ACS user
+
+Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.create({
@@ -25,7 +126,7 @@ await seam.acs.credentials.create({
});
```
-#### Response
+#### Output
```javascript
{
@@ -43,7 +144,7 @@ await seam.acs.credentials.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.create(
@@ -60,7 +161,7 @@ seam.acs.credentials.create(
)
```
-#### Response
+#### Output
```python
AcsCredential(
@@ -78,7 +179,7 @@ AcsCredential(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.create(
@@ -95,7 +196,7 @@ seam.acs.credentials.create(
)
```
-#### Response
+#### Output
```ruby
{
@@ -113,7 +214,7 @@ seam.acs.credentials.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->create(
);
```
-#### Response
+#### Output
```php
acs->credentials->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z"
```
-#### Response
+#### Output
```seam_cli
{
@@ -174,7 +275,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -198,7 +299,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}
@@ -207,113 +308,4 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
+| Property | Description |
|---|
+acs_entrance_id UUID |
+
+ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-### `acs_system_id`
-Format: `UUID`
+ |
+acs_system_id UUID |
+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
----
-### `assa_abloy_vostio_metadata`
-
-Format: `Object`
+ |
+assa_abloy_vostio_metadata Object |
+
ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-door_name Format: String
-
-
+Child Properties
-door_number Format: Number
-
-
+- door_name String
+
+
+
+- door_number Number
+
+
+
+- door_type Enum
-door_type Format: Enum
-Possible enum values:
-- `CommonDoor`
-- `EntranceDoor`
-- `GuestDoor`
-- `Elevator`
-
-pms_id Format: String
+Enum values:
+
+ - `CommonDoor`
+ - `EntranceDoor`
+ - `GuestDoor`
+ - `Elevator`
-
-stand_open Format: Boolean
+
+
+- pms_id String
+
+
+
+- stand_open Boolean
+
+
----
-### `created_at`
-Format: `Datetime`
+ |
+created_at Datetime |
+
Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created.
----
-### `display_name`
-
-Format: `String`
+ |
+display_name String |
+
Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
----
-
-### `dormakaba_community_metadata`
-Format: `Object`
+ |
+dormakaba_community_metadata Object |
+
dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-access_point_name Format: String
-
----
+Child Properties
+
+- access_point_name String
-### `errors`
-Format: `List`
+
+
-Item format: `Object`
+ |
+errors List of Objects |
+
Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-error_code Format: String
+Child Object Properties
+
+- error_code String
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
-
-message Format: String
+- message String
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
----
-### `latch_metadata`
-Format: `Object`
+ |
+latch_metadata Object |
+
Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-accessibility_type Format: String
-
-
+Child Properties
-door_name Format: String
-
-
+- accessibility_type String
+
+
+
+- door_name String
+
+
+
+- door_type String
+
+
+
+- is_connected Boolean
-door_type Format: String
-
-
-is_connected Format: Boolean
----
-### `salto_ks_metadata`
-Format: `Object`
+ |
+salto_ks_metadata Object |
+
Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-battery_level Format: String
-
-
+Child Properties
-door_name Format: String
-
-
+- battery_level String
-intrusion_alarm Format: Boolean
-
-
-left_open_alarm Format: Boolean
-
-
-lock_type Format: String
-
-
+- door_name String
-locked_state Format: String
-
-
-online Format: Boolean
-
-
-privacy_mode Format: Boolean
+- intrusion_alarm Boolean
+
+
+
+- left_open_alarm Boolean
+
+
+
+- lock_type String
+
+
+
+- locked_state String
+
+
+
+- online Boolean
+
+
+
+- privacy_mode Boolean
+
+
----
-### `salto_space_metadata`
-Format: `Object`
+ |
+salto_space_metadata Object |
+
Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-door_description Format: String
-
-
+Child Properties
+
+- door_description String
+
+
+
+- door_name String
+
+
+
+- ext_door_id String
-door_name Format: String
-
-
-ext_door_id Format: String
----
-### `visionline_metadata`
-Format: `Object`
+ |
+visionline_metadata Object |
+
Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-door_category Format: Enum
+Child Properties
+
+- door_category Enum
+
-Possible enum values:
-- `entrance`
-- `guest`
-- `elevator reader`
-- `common`
-- `common (PMS)`
-
-door_name Format: String
+Enum values:
+
+ - `entrance`
+ - `guest`
+ - `elevator reader`
+ - `common`
+ - `common (PMS)`
-
-profiles Format: List Item format: Object
-- visionline_door_profile_id Format: String
+
+- door_name String
+
+
+
+- profiles List of Objects
+
+
+- visionline_door_profile_id String
-- visionline_door_profile_type Format: Enum
- Possible enum values:
+- visionline_door_profile_type Enum
+
+
+
+
+Enum values:
+
- `BLE`
- `commonDoor`
- `touch`
+
+
+
----
-## Endpoints
-### [`/acs/entrances/get`](./get.md)
+ |
-Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-### [`/acs/entrances/grant_access`](./grant_access.md)
+
+## Events
-### [`/acs/entrances/list`](./list.md)
+
+| Property | Description |
|---|
+acs_access_group_count Number |
+
+
+ |
+
+acs_system_id UUID |
+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `can_add_acs_users_to_acs_access_groups`
+ |
-Format: `Boolean`
+acs_user_count Number |
+
-Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
+ |
----
+can_add_acs_users_to_acs_access_groups Boolean |
+
+Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
-### `can_automate_enrollment`
-Format: `Boolean`
+ |
+can_automate_enrollment Boolean |
+
Indicates whether it is possible to [launch enrollment automations](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `can_create_acs_access_groups`
-
-Format: `Boolean`
+ |
+can_create_acs_access_groups Boolean |
+
Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
----
-
-### `can_remove_acs_users_from_acs_access_groups`
-Format: `Boolean`
+ |
+can_remove_acs_users_from_acs_access_groups Boolean |
+
Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
----
-
-### `connected_account_id`
-Format: `UUID`
+ |
+connected_account_id UUID |
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `connected_account_ids`
+ |
+
+connected_account_ids List of UUIDs |
+
+IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
{% hint style="warning" %}
**Deprecated**. Use `connected_account_id`.
{% endhint %}
-Format: `List`
-
-Item format: `UUID`
-
-IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-
----
-### `created_at`
-
-Format: `Datetime`
+ |
+created_at Datetime |
+
Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.
----
-
-### `default_credential_manager_acs_system_id`
-Format: `UUID`
+ |
+default_credential_manager_acs_system_id UUID |
+
ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-
-### [`errors`](./#errors-1)
-
-Format: `List`
-Item format: `Object`
+ |
+errors List of Objects |
+
Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-
-### `external_type`
-Format: `Enum`
+ |
+external_type Enum |
+
Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
-Possible enum values:
+
+
+Enum values
+
- `pti_site`
- `alta_org`
- `salto_ks_site`
@@ -116,70 +159,72 @@ Possible enum values:
- `legic_connect_credential_service`
- `assa_abloy_vostio`
- `assa_abloy_vostio_credential_service`
+
----
-
-### `external_type_display_name`
-Format: `String`
+ |
+external_type_display_name String |
+
Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
----
-
-### `image_alt_text`
-Format: `String`
+ |
+image_alt_text String |
+
Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.
----
-
-### `image_url`
-Format: `String`
+ |
+image_url String |
+
URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `is_credential_manager`
-
-Format: `Boolean`
+ |
+is_credential_manager Boolean |
+
Indicates whether the `acs_system` is a credential manager.
----
-### `location`
-
-Format: `Object`
+ |
+location Object |
+
-time_zone Format: String
+Child Properties
+
+- time_zone String
+
+ Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
+
-Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
----
-### `name`
-Format: `String`
+ |
+name String |
+
Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `system_type`
+ |
+system_type Enum |
+
{% hint style="warning" %}
**Deprecated**. Use `external_type`.
{% endhint %}
-Format: `Enum`
+
+
+Enum values
-Possible enum values:
- `pti_site`
- `alta_org`
- `salto_ks_site`
@@ -193,269 +238,290 @@ Possible enum values:
- `legic_connect_credential_service`
- `assa_abloy_vostio`
- `assa_abloy_vostio_credential_service`
+
----
-### `system_type_display_name`
+ |
+system_type_display_name String |
+
{% hint style="warning" %}
**Deprecated**. Use `external_type_display_name`.
{% endhint %}
-Format: `String`
----
+ |
-### `visionline_metadata`
+visionline_metadata Object |
+
+
-Format: `Object`
+Child Properties
-
+- lan_address String
-lan_address Format: String
+ IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-
-
-mobile_access_uuid Format: String
-Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-
-
+- mobile_access_uuid String
-system_id Format: String
+ Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
-
----
-### [`warnings`](./#warnings-1)
-Format: `List`
+- system_id String
-Item format: `Object`
+ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
-Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
+
+
+
+ |
+
+warnings List of Objects |
+
+Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-### `workspace_id`
-Format: `UUID`
+ |
+workspace_id UUID |
+
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
+
+ |
+
+
## Errors
-### `seam_bridge_disconnected`
+
+| Error | Description |
|---|
+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.
+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.
This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md).
- See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).
+ See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). |
+
+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). |
+
+visionline_instance_unreachable |
-### `visionline_instance_unreachable`
-
-Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
+Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md).
- See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).
+ See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). |
+
+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. |
+
+acs_system_disconnected |
-### `salto_ks_subscription_limit_exceeded`
+Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue. |
+
+account_disconnected |
-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.
+Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access. |
+
+salto_ks_certification_expired |
----
+Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. |
+
+
-### `acs_system_disconnected`
+## Warnings
-Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue.
+
+| Property | Description |
|---|
+access_schedule Object |
+
`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.
-ends_at Format: Datetime
+Child Properties
-Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
+- ends_at Datetime
+
+ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+
+- starts_at Datetime
+
+ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-starts_at Format: Datetime
-Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
----
-### `acs_system_id`
-Format: `UUID`
+ |
+acs_system_id UUID |
+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-
-### `acs_user_id`
-Format: `UUID`
+ |
+acs_user_id UUID |
+
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-
-### `created_at`
-Format: `Datetime`
+ |
+created_at Datetime |
+
Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
----
-
-### `display_name`
-Format: `String`
+ |
+display_name String |
+
Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-### `email`
+ |
+email String |
+
{% hint style="warning" %}
**Deprecated**. use email_address.
{% endhint %}
-Format: `String`
-
----
-
-### `email_address`
-Format: `String`
+ |
+email_address String |
+
Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-
-### [`errors`](./#errors-1)
-
-Format: `List`
-Item format: `Object`
+ |
+errors List of Objects |
+
Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-
-### `external_type`
-Format: `Enum`
+ |
+external_type Enum |
+
Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
-Possible enum values:
+
+
+Enum values
+
- `pti_user`
- `brivo_user`
- `hid_credential_manager_user`
@@ -102,242 +141,254 @@ Possible enum values:
- `latch_user`
- `dormakaba_community_user`
- `salto_space_user`
+
----
-
-### `external_type_display_name`
-Format: `String`
+ |
+external_type_display_name String |
+
Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
----
-
-### `full_name`
-Format: `String`
+ |
+full_name String |
+
Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-### `hid_acs_system_id`
+ |
-Format: `UUID`
+hid_acs_system_id UUID |
+
----
+ |
-### `is_managed`
+is_managed Boolean |
+
-Format: `Boolean`
+ |
----
+is_suspended Boolean |
+
+Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).
-### `is_suspended`
-Format: `Boolean`
+ |
-Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).
+phone_number String |
+
+Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
----
-### `phone_number`
+ |
-Format: `String`
+user_identity_email_address String |
+
+Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
----
+ |
-### `user_identity_email_address`
+user_identity_full_name String |
+
+Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Format: `String`
-Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+ |
----
+user_identity_id String |
+
+ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### `user_identity_full_name`
-Format: `String`
+ |
-Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+user_identity_phone_number String |
+
+Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
----
-### `user_identity_id`
+ |
-Format: `String`
+warnings List of Objects |
+
+Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
+ |
+
+workspace_id UUID |
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### `user_identity_phone_number`
-Format: `String`
+ |
-Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+
----
+## Errors
-### [`warnings`](./#warnings-1)
+
+| Error | Description |
|---|
+deleted_externally |
-Format: `List`
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam. |
+
+salto_ks_subscription_limit_exceeded |
-Item format: `Object`
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. |
+
+failed_to_create_on_acs_system |
-Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). |
+
+failed_to_update_on_acs_system |
----
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). |
+
+failed_to_delete_on_acs_system |
+
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). |
+
+
-### `workspace_id`
+## Warnings
-Format: `UUID`
+
+| Parameter | Description |
|---|
+acs_system_id String (Required) |
+
+
+ID of the `acs_system` to which to add the new `acs_user`.
+ |
+full_name String (Required) |
+
+
+Full name of the new `acs_user`.
+ |
+access_schedule Object |
+
+
+`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.
+ |
+acs_access_group_ids Array of UUIDs |
+
+
+Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.
+ |
+email String |
+
+ |
+email_address String |
+
+
+Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+ |
+phone_number String |
+
+
+Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+ |
+user_identity_id String |
+
+
+ID of the user identity with which to associate the new `acs_user`.
+ |
+
+
+## Response
+
+[acs\_user](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a new ACS user
Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.create({
@@ -16,11 +100,10 @@ await seam.acs.users.create({
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100",
- acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
});
```
-#### Response
+#### Output
```javascript
{
@@ -37,7 +120,7 @@ await seam.acs.users.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.create(
@@ -45,11 +128,10 @@ seam.acs.users.create(
full_name="Jane Doe",
email_address="jane@example.com",
phone_number="+15555550100",
- acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
)
```
-#### Response
+#### Output
```python
AcsUser(
@@ -66,7 +148,7 @@ AcsUser(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.create(
@@ -74,11 +156,10 @@ seam.acs.users.create(
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100",
- acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
)
```
-#### Response
+#### Output
```ruby
{
@@ -95,7 +176,7 @@ seam.acs.users.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
- phone_number: "+15555550100",
- acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"]
+ phone_number: "+15555550100"
);
```
-#### Response
+#### Output
```php
acs->users->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
-seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"]
+seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100"
```
-#### Response
+#### Output
```seam_cli
{
@@ -149,7 +229,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -161,17 +241,16 @@ func main() {
client.Acs.Users.Create(
context.Background(),
users.UsersCreateRequest{
- AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
- FullName: api.String("Jane Doe"),
- EmailAddress: api.String("jane@example.com"),
- PhoneNumber: api.String("+15555550100"),
- AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")},
+ AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ FullName: api.String("Jane Doe"),
+ EmailAddress: api.String("jane@example.com"),
+ PhoneNumber: api.String("+15555550100"),
},
)
}
```
-#### Response
+#### Output
```go
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
@@ -180,86 +259,370 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
+| Parameter | Description |
|---|
+acs_system_id String |
+
+
+ID of the `acs_system` for which you want to retrieve all `acs_user`s.
+ |
+created_before String |
+
+ |
+limit Number |
+
+
+Maximum number of records to return per page.
+ |
+page_cursor String |
+
+
+Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+ |
+search String |
+
+
+String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.
+ |
+user_identity_email_address String |
+
+
+Email address of the user identity for which you want to retrieve all `acs_user`s.
+ |
+user_identity_id String |
+
+
+ID of the user identity for which you want to retrieve all `acs_user`s.
+ |
+user_identity_phone_number String |
+
+
+Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).
+ |
+
+
+## Response
+
+Array of [acs\_users](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List all ACS users
Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.list();
```
-#### Response
+#### Output
```javascript
{
@@ -31,13 +116,13 @@ await seam.acs.users.list();
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.list()
```
-#### Response
+#### Output
```python
AcsUser(
@@ -54,13 +139,13 @@ AcsUser(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.list()
```
-#### Response
+#### Output
```ruby
{
@@ -77,14 +162,14 @@ seam.acs.users.list()
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->list();
```
-#### Response
+#### Output
```php
acs->users->list();
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users list
```
-#### Response
+#### Output
```seam_cli
{
@@ -125,7 +210,7 @@ seam acs users list
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -135,7 +220,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
@@ -144,87 +229,4 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
+| Property | Description |
|---|
+created_at Datetime |
+
+Date and time at which the `phone` was created.
-Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.
----
+ |
-### `device_id`
+custom_metadata Record |
+
+Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.
-Format: `UUID`
-ID of the `phone`.
+ |
----
+device_id UUID |
+
+ID of the `phone`.
-### `device_type`
-Format: `Enum`
+ |
+device_type Enum |
+
Type of phone.
-Possible enum values:
+
+
+Enum values
+
- `ios_phone`
- `android_phone`
+
----
-
-### `display_name`
-Format: `String`
+ |
+display_name String |
+
Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
----
-
-### `errors`
-
-Format: `List`
-Item format: `Object`
+ |
+errors List of Objects |
+
Errors associated with the `phone`.
-error_code Format: String
-
-
+Child Object Properties
+
+- error_code String
+
+
+
+- message String
+
-message Format: String
----
-### `nickname`
-Format: `String`
+ |
+nickname String |
+
Optional nickname to describe the phone, settable through Seam.
----
-
-### `properties`
-Format: `Object`
+ |
+properties Object |
+
Properties of the phone.
-assa_abloy_credential_service_metadata Format: Object
+Child Properties
-ASSA ABLOY Credential Service metadata for the phone.
-
-
+- assa_abloy_credential_service_metadata Object
+
+ ASSA ABLOY Credential Service metadata for the phone.
-assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object
-Endpoints associated with the phone.
-- endpoint_id Format: String
+- assa_abloy_credential_service_metadata.endpoints List of Objects
+
+ Endpoints associated with the phone.
+
+
+- endpoint_id String
ID of the associated endpoint.
-- is_active Format: Boolean
+
+- is_active Boolean
Indicated whether the endpoint is active.
-
-
-assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean
-Indicates whether the credential service has active endpoints associated with the phone.
-
-
-salto_space_credential_service_metadata Format: Object
+- assa_abloy_credential_service_metadata.has_active_endpoint Boolean
-Salto Space credential service metadata for the phone.
-
-
+ Indicates whether the credential service has active endpoints associated with the phone.
-salto_space_credential_service_metadata.has_active_phone Format: Boolean
-Indicates whether the credential service has an active associated phone.
-
----
-### `warnings`
+- salto_space_credential_service_metadata Object
-Format: `List`
+ Salto Space credential service metadata for the phone.
-Item format: `Object`
-Warnings associated with the `phone`.
-
+- salto_space_credential_service_metadata.has_active_phone Boolean
+
+ Indicates whether the credential service has an active associated phone.
+
-message Format: String
+
+
+ |
+
+warnings List of Objects |
+
+Warnings associated with the `phone`.
+
-warning_code Format: String
-
----
+Child Object Properties
-### `workspace_id`
+- message String
-Format: `UUID`
-ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`.
----
+- warning_code String
-## Endpoints
-### [`/phones/deactivate`](./deactivate.md)
+
-Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).
-### [`/phones/get`](./get.md)
-Returns a single phone entry matching the provided `device_id`.
-### [`/phones/list`](./list.md)
+ |
-Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+workspace_id UUID |
+
+ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`.
----
-## Events
+ |
-### `phone.deactivated`
+
+## Events
+
+
+| Endpoint | Description |
|---|
+
+/thermostats/activate_climate_preset |
+
+Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
+
+
+/thermostats/cool |
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). |
+
+
+/thermostats/create_climate_preset |
+
+Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
+
+
+/thermostats/delete_climate_preset |
+
+Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
+
+
+/thermostats/heat |
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). |
+
+
+/thermostats/heat_cool |
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). |
+
+
+/thermostats/list |
+
+Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). |
+
+
+/thermostats/off |
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). |
+
+
+/thermostats/set_fallback_climate_preset |
+
+Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
-Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/cool`](./cool.md)
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/create_climate_preset`](./create_climate_preset.md)
+/thermostats/set_fan_mode |
-Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/delete_climate_preset`](./delete_climate_preset.md)
+Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
-Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/heat`](./heat.md)
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/heat_cool`](./heat_cool.md)
+/thermostats/set_hvac_mode |
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/list`](./list.md)
+Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
-Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/off`](./off.md)
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/set_fallback_climate_preset`](./set_fallback_climate_preset.md)
+/thermostats/set_temperature_threshold |
-Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/set_fan_mode`](./set_fan_mode.md)
+Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. |
-Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/set_hvac_mode`](./set_hvac_mode.md)
-Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/set_temperature_threshold`](./set_temperature_threshold.md)
+/thermostats/update_climate_preset |
-Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
-### [`/thermostats/update_climate_preset`](./update_climate_preset.md)
+Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). |
-Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index 54efb64e9..67edb3f37 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -1,14 +1,74 @@
# Activate a Climate Preset
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/activate_climate_preset ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+| Parameter | Description |
|---|
+climate_preset_key String (Required) |
+
+
+Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+ |
+device_id String (Required) |
+
+
+ID of the desired thermostat device.
+ |
+cooling_set_point_celsius Number |
+
+
+Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+cooling_set_point_fahrenheit Number |
+
+
+Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+fan_mode_setting String |
+
+
+Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+ |
+heating_set_point_celsius Number |
+
+
+Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+heating_set_point_fahrenheit Number |
+
+
+Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+hvac_mode_setting String |
+
+
+Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+ |
+manual_override_allowed Boolean |
+
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
+ |
+name String |
+
+
+User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+ |
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Create a climate preset
+
+Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.createClimatePreset({
@@ -23,7 +111,7 @@ await seam.thermostats.createClimatePreset({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -31,7 +119,7 @@ await seam.thermostats.createClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.create_climate_preset(
@@ -46,7 +134,7 @@ seam.thermostats.create_climate_preset(
)
```
-#### Response
+#### Output
```python
None
@@ -54,7 +142,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.create_climate_preset(
@@ -69,7 +157,7 @@ seam.thermostats.create_climate_preset(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -77,7 +165,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->create_climate_preset(
);
```
-#### Response
+#### Output
```php
null
@@ -101,13 +189,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true
```
-#### Response
+#### Output
```seam_cli
{}
@@ -115,7 +203,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -139,7 +227,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -148,105 +236,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
+| Parameter | Description |
|---|
+device_id String (Required) |
+
+
+ID of the desired thermostat device.
+ |
+cooling_set_point_celsius Number |
+
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+ |
+cooling_set_point_fahrenheit Number |
+
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+ |
+heating_set_point_celsius Number |
+
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+ |
+heating_set_point_fahrenheit Number |
+
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+ |
+
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set to heat-cool (auto) mode
+
+Specify the desired heating set point in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.heatCool({
@@ -18,7 +94,7 @@ await seam.thermostats.heatCool({
});
```
-#### Response
+#### Output
```javascript
{
@@ -30,7 +106,7 @@ await seam.thermostats.heatCool({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.heat_cool(
@@ -40,7 +116,7 @@ seam.thermostats.heat_cool(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -52,7 +128,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.heat_cool(
@@ -62,7 +138,7 @@ seam.thermostats.heat_cool(
)
```
-#### Response
+#### Output
```ruby
{
@@ -74,7 +150,7 @@ seam.thermostats.heat_cool(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->heat_cool(
);
```
-#### Response
+#### Output
```php
thermostats->heat_cool(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20
```
-#### Response
+#### Output
```seam_cli
{
@@ -116,7 +192,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -135,7 +211,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"}
@@ -144,90 +220,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
+| Parameter | Description |
|---|
+connect_webview_id String |
+
+
+ID of the Connect Webview by which to filter devices.
+ |
+connected_account_id String |
+
+
+ID of the connected account by which to filter.
+ |
+connected_account_ids Array of UUIDs |
+
+
+Array of IDs of the connected accounts by which to filter devices.
+ |
+created_before String |
+
+
+Date threshold for devices to return. If specified, returns only devices created before the specified date.
+ |
+custom_metadata_has Object |
+
+
+Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.
+ |
+device_ids Array of UUIDs |
+
+
+Array of device IDs by which to filter devices.
+ |
+device_type String |
+
+
+Device type by which to filter devices.
+ |
+device_types Array of Enums |
+
+
+Array of device types by which to filter devices.
+
+
+Enum values
+
+Possible enum values:
+- `ecobee_thermostat`
+- `nest_thermostat`
+- `honeywell_resideo_thermostat`
+- `tado_thermostat`
+- `sensi_thermostat`
+
+ |
+limit Number |
+
+
+Numerical limit on the number of devices to return.
+ |
+manufacturer String |
+
+
+Manufacturer by which to filter devices.
+ |
+user_identifier_key String |
+
+
+Your own internal user ID for the user by which to filter devices.
+ |
+
+
+## Response
+
+Array of [devices](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of device
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List thermostats
+
+To filter the list of returned thermostats, specify the desired parameters.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.list();
```
-#### Response
+#### Output
```javascript
[
@@ -45,13 +158,13 @@ await seam.thermostats.list();
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.list()
```
-#### Response
+#### Output
```python
[
@@ -82,13 +195,13 @@ seam.thermostats.list()
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.list()
```
-#### Response
+#### Output
```ruby
[
@@ -119,14 +232,14 @@ seam.thermostats.list()
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->list();
```
-#### Response
+#### Output
```php
thermostats->list();
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats list
```
-#### Response
+#### Output
```seam_cli
[
@@ -200,7 +313,7 @@ seam thermostats list
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -210,7 +323,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}}
@@ -219,114 +332,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
+| Property | Description |
|---|
+climate_preset_key String |
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.
----
+ |
-### `device_id`
+created_at Datetime |
+
+Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.
-Format: `UUID`
-ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.
+ |
----
+device_id UUID |
+
+ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.
-### `ends_at`
-Format: `Datetime`
+ |
+ends_at Datetime |
+
Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
----
-
-### `errors`
-
-Format: `List`
-Item format: `Object`
+ |
+errors List of Objects |
+
Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-error_code Format: String
+Child Object Properties
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
-
+- error_code String
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+
+
+- message String
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-message Format: String
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
----
-### `max_override_period_minutes`
-Format: `Number`
+ |
+max_override_period_minutes Number |
+
Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
----
-
-### `name`
-Format: `String`
+ |
+name String |
+
User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
----
-
-### `starts_at`
-Format: `Datetime`
+ |
+starts_at Datetime |
+
Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
----
-
-### `thermostat_schedule_id`
-Format: `UUID`
+ |
+thermostat_schedule_id UUID |
+
ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
----
+
+ |
+
+
+
## Endpoints
-### [`/thermostats/schedules/create`](./create.md)
+
+| Parameter | Description |
|---|
+climate_preset_key String (Required) |
+
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+ |
+device_id String (Required) |
+
+
+ID of the desired thermostat device.
+ |
+ends_at String (Required) |
+
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+starts_at String (Required) |
+
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+is_override_allowed Boolean |
+
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+ |
+max_override_period_minutes Number |
+
+
+Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+ |
+name String |
+
+
+User-friendly name to identify the thermostat schedule.
+ |
+
+
+## Response
+
+[thermostat\_schedule](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of thermostat_schedule
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a thermostat schedule
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.create({
@@ -21,7 +103,7 @@ await seam.thermostats.schedules.create({
});
```
-#### Response
+#### Output
```javascript
{
@@ -37,7 +119,7 @@ await seam.thermostats.schedules.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.create(
@@ -50,7 +132,7 @@ seam.thermostats.schedules.create(
)
```
-#### Response
+#### Output
```python
ThermostatSchedule(
@@ -66,7 +148,7 @@ ThermostatSchedule(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.create(
@@ -79,7 +161,7 @@ seam.thermostats.schedules.create(
)
```
-#### Response
+#### Output
```ruby
{
@@ -95,7 +177,7 @@ seam.thermostats.schedules.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->create(
);
```
-#### Response
+#### Output
```php
thermostats->schedules->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90
```
-#### Response
+#### Output
```seam_cli
{
@@ -148,7 +230,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -171,7 +253,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90}
@@ -180,78 +262,4 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746
{% endtabs %}
-## Authentication Methods
-- API key
-- Client session token
-- Personal access token
-
+| Parameter | Description |
|---|
+thermostat_schedule_id String (Required) |
+
+
+ID of the desired thermostat schedule.
+ |
+climate_preset_key String |
+
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+ |
+ends_at String |
+
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+is_override_allowed Boolean |
+
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+ |
+max_override_period_minutes Number |
+
+
+Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+ |
+name String |
+
+
+User-friendly name to identify the thermostat schedule.
+ |
+starts_at String |
+
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ |
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Update a thermostat schedule
+
+Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.update({
@@ -17,7 +90,7 @@ await seam.thermostats.schedules.update({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +98,7 @@ await seam.thermostats.schedules.update({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.update(
@@ -34,7 +107,7 @@ seam.thermostats.schedules.update(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +115,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.update(
@@ -51,7 +124,7 @@ seam.thermostats.schedules.update(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +132,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->update(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +150,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +164,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +183,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,78 +192,4 @@ nil
{% endtabs %}
-## Authentication Methods
-- API key
-- Client session token
-- Personal access token
-
+| Parameter | Description |
|---|
+device_id String (Required) |
+
+
+ID of the desired thermostat device.
+ |
+hvac_mode_setting String (Required) |
+
+ |
+cooling_set_point_celsius Number |
+
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+ |
+cooling_set_point_fahrenheit Number |
+
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+ |
+heating_set_point_celsius Number |
+
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+ |
+heating_set_point_fahrenheit Number |
+
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+ |
+
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set HVAC mode
+
+Specify the desired heating and cooling set points in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.setHvacMode({
@@ -19,7 +98,7 @@ await seam.thermostats.setHvacMode({
});
```
-#### Response
+#### Output
```javascript
{
@@ -31,7 +110,7 @@ await seam.thermostats.setHvacMode({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.set_hvac_mode(
@@ -42,7 +121,7 @@ seam.thermostats.set_hvac_mode(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -54,7 +133,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.set_hvac_mode(
@@ -65,7 +144,7 @@ seam.thermostats.set_hvac_mode(
)
```
-#### Response
+#### Output
```ruby
{
@@ -77,7 +156,7 @@ seam.thermostats.set_hvac_mode(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->set_hvac_mode(
);
```
-#### Response
+#### Output
```php
thermostats->set_hvac_mode(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25
```
-#### Response
+#### Output
```seam_cli
{
@@ -120,7 +199,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -140,7 +219,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"}
@@ -149,99 +228,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
+| Parameter | Description |
|---|
+device_id String (Required) |
+
ID of the desired thermostat device.
-
-***
-
-### `hvac_mode`
-
-Type: `string`
-Required: Yes
+ |
+hvac_mode String (Required) |
+
Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate.
-
-***
-
-### `cooling_set_point_celsius`
-
-Type: `number`
-Required: No
+ |
+cooling_set_point_celsius Number |
+
Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.
-
-***
-
-### `cooling_set_point_fahrenheit`
-
-Type: `number`
-Required: No
+ |
+cooling_set_point_fahrenheit Number |
+
Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.
-
-***
-
-### `heating_set_point_celsius`
-
-Type: `number`
-Required: No
+ |
+heating_set_point_celsius Number |
+
Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.
-
-***
-
-### `heating_set_point_fahrenheit`
-
-Type: `number`
-Required: No
+ |
+heating_set_point_fahrenheit Number |
+
Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.
+ |
+
-***
-
-## Return Type
+## Response
void
diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md
index 467b35d50..06a82dff0 100644
--- a/docs/api/thermostats/simulate/temperature_reached.md
+++ b/docs/api/thermostats/simulate/temperature_reached.md
@@ -1,46 +1,51 @@
# Temperature Reached
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/simulate/temperature_reached ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
+| Parameter | Description |
|---|
+climate_preset_key String (Required) |
+
+
+Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+ |
+device_id String (Required) |
+
+
+ID of the desired thermostat device.
+ |
+manual_override_allowed Boolean (Required) |
+
+
+Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+ |
+cooling_set_point_celsius Number |
+
+
+Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+cooling_set_point_fahrenheit Number |
+
+
+Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+fan_mode_setting String |
+
+
+Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+ |
+heating_set_point_celsius Number |
+
+
+Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+heating_set_point_fahrenheit Number |
+
+
+Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ |
+hvac_mode_setting String |
+
+
+Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+ |
+name String |
+
+
+User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+ |
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Update a climate preset
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.updateClimatePreset({
@@ -19,7 +107,7 @@ await seam.thermostats.updateClimatePreset({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -27,7 +115,7 @@ await seam.thermostats.updateClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.update_climate_preset(
@@ -38,7 +126,7 @@ seam.thermostats.update_climate_preset(
)
```
-#### Response
+#### Output
```python
None
@@ -46,7 +134,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.update_climate_preset(
@@ -57,7 +145,7 @@ seam.thermostats.update_climate_preset(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -65,7 +153,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->update_climate_preset(
);
```
-#### Response
+#### Output
```php
null
@@ -85,13 +173,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true
```
-#### Response
+#### Output
```seam_cli
{}
@@ -99,7 +187,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -119,7 +207,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -128,105 +216,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
+| Endpoint | Description |
|---|
+
+/user_identities/add_acs_user |
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
+
+
+/user_identities/create |
+
+Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
+
+
+/user_identities/delete |
+
+Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. |
+
+
+/user_identities/get |
+
+Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
+
+
+/user_identities/grant_access_to_device |
+
+Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). |
+
+
+/user_identities/list |
+
+Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
+
+
+/user_identities/list_accessible_devices |
+
+Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
+
+
+/user_identities/list_acs_systems |
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/create`](./create.md)
-Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/delete`](./delete.md)
+/user_identities/list_acs_users |
-Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
-### [`/user_identities/get`](./get.md)
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
-Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/grant_access_to_device`](./grant_access_to_device.md)
-Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md).
-### [`/user_identities/list`](./list.md)
+/user_identities/remove_acs_user |
-Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/list_accessible_devices`](./list_accessible_devices.md)
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
-Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/list_acs_systems`](./list_acs_systems.md)
-Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/list_acs_users`](./list_acs_users.md)
+/user_identities/revoke_access_to_device |
-Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/remove_acs_user`](./remove_acs_user.md)
+Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). |
-Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/revoke_access_to_device`](./revoke_access_to_device.md)
-Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/update`](./update.md)
+/user_identities/update |
+ |
+
diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md
index af928ae44..81742a474 100644
--- a/docs/api/user_identities/add_acs_user.md
+++ b/docs/api/user_identities/add_acs_user.md
@@ -1,14 +1,61 @@
# Add an ACS User to a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PUT /user_identities/add_acs_user ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+| Parameter | Description |
|---|
+credential_manager_acs_system_id String (Required) |
+
+
+ID of the desired ACS system that serves as the credential manager.
+ |
+user_identity_id String (Required) |
+
+
+ID of the desired user identity.
+ |
+acs_credential_pool_id String |
+
+
+ID of the ACS credential pool from which to obtain credentials for the user identity.
+ |
+create_credential_manager_user Boolean |
+
+
+Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.
+ |
+credential_manager_acs_user_id String |
+
+
+ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.
+ |
+
+
+## Response
+
+[unknown](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of unknown
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Launch an enrollment automation
+
+Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.enrollmentAutomations.launch({
@@ -19,7 +90,7 @@ await seam.userIdentities.enrollmentAutomations.launch({
});
```
-#### Response
+#### Output
```javascript
{
@@ -35,7 +106,7 @@ await seam.userIdentities.enrollmentAutomations.launch({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.enrollment_automations.launch(
@@ -46,7 +117,7 @@ seam.user_identities.enrollment_automations.launch(
)
```
-#### Response
+#### Output
```python
Unknown(
@@ -62,7 +133,7 @@ Unknown(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.enrollment_automations.launch(
@@ -73,7 +144,7 @@ seam.user_identities.enrollment_automations.launch(
)
```
-#### Response
+#### Output
```ruby
{
@@ -89,7 +160,7 @@ seam.user_identities.enrollment_automations.launch(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->enrollment_automations->launch(
);
```
-#### Response
+#### Output
```php
user_identities->enrollment_automations->launch(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true
```
-#### Response
+#### Output
```seam_cli
{
@@ -142,7 +213,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -163,7 +234,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
@@ -172,59 +243,4 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-