Class SeamHttpUserIdentities
Constructors
constructor
- new SeamHttpUserIdentities(apiKeyOrOptions?): SeamHttpUserIdentities
Properties
client
client: AxiosInstance
Readonly
defaults
Accessors
Methods
addAcsUser
- addAcsUser(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
acs_user_id: string;
user_identity_id: string;
}acs_user_id: string
user_identity_id: string
create
- create(body?): SeamHttpRequest<SetNonNullable<Required<{
user_identity: {
created_at: string;
display_name: string;
email_address: null | string;
full_name: null | string;
phone_number: null | string;
user_identity_id: string;
user_identity_key: null | string;
workspace_id: string;
};
}>, "user_identity">, "user_identity"> Parameters
Optional
body: {
email_address?: null | string;
full_name?: null | string;
phone_number?: null | string;
user_identity_key?: null | string;
}Optional
email_address?: null | string
Optional
full_name?: null | string
Optional
phone_number?: null | string
Optional
user_identity_key?: null | string
Returns SeamHttpRequest<SetNonNullable<Required<{
user_identity: {
created_at: string;
display_name: string;
email_address: null | string;
full_name: null | string;
phone_number: null | string;
user_identity_id: string;
user_identity_key: null | string;
workspace_id: string;
};
}>, "user_identity">, "user_identity">
delete
- delete(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
user_identity_id: string;
}
get
- get(body?): SeamHttpRequest<SetNonNullable<Required<{
user_identity: {
created_at: string;
display_name: string;
email_address: null | string;
full_name: null | string;
phone_number: null | string;
user_identity_id: string;
user_identity_key: null | string;
workspace_id: string;
};
}>, "user_identity">, "user_identity"> Returns SeamHttpRequest<SetNonNullable<Required<{
user_identity: {
created_at: string;
display_name: string;
email_address: null | string;
full_name: null | string;
phone_number: null | string;
user_identity_id: string;
user_identity_key: null | string;
workspace_id: string;
};
}>, "user_identity">, "user_identity">
grantAccessToDevice
- grantAccessToDevice(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
device_id: string;
user_identity_id: string;
}device_id: string
user_identity_id: string
list
- list(body?): SeamHttpRequest<SetNonNullable<Required<{
user_identities: {
created_at: string;
display_name: string;
email_address: null | string;
full_name: null | string;
phone_number: null | string;
user_identity_id: string;
user_identity_key: null | string;
workspace_id: string;
}[];
}>, "user_identities">, "user_identities"> Parameters
Optional
body: {
credential_manager_acs_system_id?: string;
}Optional
credential_manager_acs_system_id?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
user_identities: {
created_at: string;
display_name: string;
email_address: null | string;
full_name: null | string;
phone_number: null | string;
user_identity_id: string;
user_identity_key: null | string;
workspace_id: string;
}[];
}>, "user_identities">, "user_identities">
listAccessibleDevices
- listAccessibleDevices(body?): SeamHttpRequest<SetNonNullable<Required<{
accessible_devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
capabilities_supported: (
| "access_code"
| "phone"
| "lock"
| "noise_detection"
| "thermostat"
| "battery")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
device_type:
| "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "noiseaware_activity_zone"
| "minut_sensor"
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: ({
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status:
| (...)
| (...)
| (...)
| (...);
};
battery_level?: number;
currently_triggering_noise_threshold_ids?: string[];
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
noise_level_decibels?: number;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
akiles_metadata?: {
_member_group_id?: (...) | (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: {
encoder_name: string;
};
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...) | (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...) | (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tado_metadata?: {
device_type: string;
serial_no: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
};
has_gateway?: (...) | (...) | (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
visionline_metadata?: {
encoder_id: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: number[];
code_constraints?: ((...) | (...))[];
door_open?: boolean;
has_native_entry_events?: boolean;
keypad_battery?: {
level: number;
};
locked?: boolean;
max_active_codes_supported?: number;
supported_code_lengths?: number[];
supports_backup_access_code_pool?: boolean;
} & {
active_thermostat_schedule?: null | {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors?: any;
max_override_period_minutes: number;
name?: (...) | (...);
starts_at: string;
thermostat_schedule_id: string;
unstable_is_override_allowed?: (...) | (...) | (...);
};
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
climate_preset_key: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: ((...) | (...) | (...))[];
available_hvac_mode_settings?: (
| (...)
| (...)
| (...)
| (...))[];
current_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
default_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
fallback_climate_preset_key?: null | string;
fan_mode_setting?: "auto" | "on" | "circulate";
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: {
lower_limit_celsius: (...) | (...);
lower_limit_fahrenheit: (...) | (...);
upper_limit_celsius: (...) | (...);
upper_limit_fahrenheit: (...) | (...);
};
};
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
capabilities_supported: (
| "access_code"
| "phone"
| "lock"
| "noise_detection"
| "thermostat"
| "battery")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
device_type:
| "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "noiseaware_activity_zone"
| "minut_sensor"
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: ({
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status:
| (...)
| (...)
| (...)
| (...);
};
battery_level?: number;
currently_triggering_noise_threshold_ids?: string[];
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
noise_level_decibels?: number;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
akiles_metadata?: {
_member_group_id?: (...) | (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: {
encoder_name: string;
};
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...) | (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...) | (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tado_metadata?: {
device_type: string;
serial_no: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
};
has_gateway?: (...) | (...) | (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
visionline_metadata?: {
encoder_id: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: number[];
code_constraints?: ((...) | (...))[];
door_open?: boolean;
has_native_entry_events?: boolean;
keypad_battery?: {
level: number;
};
locked?: boolean;
max_active_codes_supported?: number;
supported_code_lengths?: number[];
supports_backup_access_code_pool?: boolean;
} & {
active_thermostat_schedule?: null | {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors?: any;
max_override_period_minutes: number;
name?: (...) | (...);
starts_at: string;
thermostat_schedule_id: string;
unstable_is_override_allowed?: (...) | (...) | (...);
};
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
climate_preset_key: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: ((...) | (...) | (...))[];
available_hvac_mode_settings?: (
| (...)
| (...)
| (...)
| (...))[];
current_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
default_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
fallback_climate_preset_key?: null | string;
fan_mode_setting?: "auto" | "on" | "circulate";
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: {
lower_limit_celsius: (...) | (...);
lower_limit_fahrenheit: (...) | (...);
upper_limit_celsius: (...) | (...);
upper_limit_fahrenheit: (...) | (...);
};
};
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
}>, "devices" | "accessible_devices">, "devices"> Parameters
Optional
body: {
user_identity_id: string;
}
Returns SeamHttpRequest<SetNonNullable<Required<{
accessible_devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
capabilities_supported: (
| "access_code"
| "phone"
| "lock"
| "noise_detection"
| "thermostat"
| "battery")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
device_type:
| "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "noiseaware_activity_zone"
| "minut_sensor"
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: ({
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status:
| (...)
| (...)
| (...)
| (...);
};
battery_level?: number;
currently_triggering_noise_threshold_ids?: string[];
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
noise_level_decibels?: number;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
akiles_metadata?: {
_member_group_id?: (...) | (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: {
encoder_name: string;
};
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...) | (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...) | (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tado_metadata?: {
device_type: string;
serial_no: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
};
has_gateway?: (...) | (...) | (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
visionline_metadata?: {
encoder_id: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: number[];
code_constraints?: ((...) | (...))[];
door_open?: boolean;
has_native_entry_events?: boolean;
keypad_battery?: {
level: number;
};
locked?: boolean;
max_active_codes_supported?: number;
supported_code_lengths?: number[];
supports_backup_access_code_pool?: boolean;
} & {
active_thermostat_schedule?: null | {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors?: any;
max_override_period_minutes: number;
name?: (...) | (...);
starts_at: string;
thermostat_schedule_id: string;
unstable_is_override_allowed?: (...) | (...) | (...);
};
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
climate_preset_key: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: ((...) | (...) | (...))[];
available_hvac_mode_settings?: (
| (...)
| (...)
| (...)
| (...))[];
current_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
default_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
fallback_climate_preset_key?: null | string;
fan_mode_setting?: "auto" | "on" | "circulate";
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: {
lower_limit_celsius: (...) | (...);
lower_limit_fahrenheit: (...) | (...);
upper_limit_celsius: (...) | (...);
upper_limit_fahrenheit: (...) | (...);
};
};
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
capabilities_supported: (
| "access_code"
| "phone"
| "lock"
| "noise_detection"
| "thermostat"
| "battery")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
device_type:
| "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "noiseaware_activity_zone"
| "minut_sensor"
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: ({
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status:
| (...)
| (...)
| (...)
| (...);
};
battery_level?: number;
currently_triggering_noise_threshold_ids?: string[];
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
noise_level_decibels?: number;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
akiles_metadata?: {
_member_group_id?: (...) | (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: {
encoder_name: string;
};
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...) | (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...) | (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tado_metadata?: {
device_type: string;
serial_no: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
};
has_gateway?: (...) | (...) | (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
visionline_metadata?: {
encoder_id: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: number[];
code_constraints?: ((...) | (...))[];
door_open?: boolean;
has_native_entry_events?: boolean;
keypad_battery?: {
level: number;
};
locked?: boolean;
max_active_codes_supported?: number;
supported_code_lengths?: number[];
supports_backup_access_code_pool?: boolean;
} & {
active_thermostat_schedule?: null | {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors?: any;
max_override_period_minutes: number;
name?: (...) | (...);
starts_at: string;
thermostat_schedule_id: string;
unstable_is_override_allowed?: (...) | (...) | (...);
};
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
climate_preset_key: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: ((...) | (...) | (...))[];
available_hvac_mode_settings?: (
| (...)
| (...)
| (...)
| (...))[];
current_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
default_climate_setting?: {
can_delete?: (...) | (...) | (...);
can_edit?: (...) | (...) | (...);
climate_preset_key?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
fan_mode_setting?:
| (...)
| (...)
| (...)
| (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?:
| (...)
| (...)
| (...)
| (...)
| (...);
manual_override_allowed?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
fallback_climate_preset_key?: null | string;
fan_mode_setting?: "auto" | "on" | "circulate";
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: {
lower_limit_celsius: (...) | (...);
lower_limit_fahrenheit: (...) | (...);
upper_limit_celsius: (...) | (...);
upper_limit_fahrenheit: (...) | (...);
};
};
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
}>, "devices" | "accessible_devices">, "devices">
listAcsSystems
- listAcsSystems(body?): SeamHttpRequest<SetNonNullable<Required<{
acs_systems: {
acs_system_id: string;
can_add_acs_users_to_acs_access_groups?: boolean;
can_automate_enrollment?: boolean;
can_create_acs_access_groups?: boolean;
can_remove_acs_users_from_acs_access_groups?: boolean;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: null | string;
errors: (
| {
created_at: string;
error_code: "seam_bridge_disconnected";
message: string;
}
| {
created_at: string;
error_code: "visionline_instance_unreachable";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "acs_system_disconnected";
message: string;
}
| {
created_at: string;
error_code: "account_disconnected";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_certification_expired";
message: string;
})[];
external_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: {
time_zone: null | string;
};
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: ({
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
} | {
created_at: string;
message: string;
misconfigured_acs_entrance_ids?: (...)[];
warning_code: "time_zone_does_not_match_location";
})[];
workspace_id: string;
}[];
}>, "acs_systems">, "acs_systems"> Parameters
Optional
body: {
user_identity_id: string;
}
Returns SeamHttpRequest<SetNonNullable<Required<{
acs_systems: {
acs_system_id: string;
can_add_acs_users_to_acs_access_groups?: boolean;
can_automate_enrollment?: boolean;
can_create_acs_access_groups?: boolean;
can_remove_acs_users_from_acs_access_groups?: boolean;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: null | string;
errors: (
| {
created_at: string;
error_code: "seam_bridge_disconnected";
message: string;
}
| {
created_at: string;
error_code: "visionline_instance_unreachable";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "acs_system_disconnected";
message: string;
}
| {
created_at: string;
error_code: "account_disconnected";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_certification_expired";
message: string;
})[];
external_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: {
time_zone: null | string;
};
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: ({
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
} | {
created_at: string;
message: string;
misconfigured_acs_entrance_ids?: (...)[];
warning_code: "time_zone_does_not_match_location";
})[];
workspace_id: string;
}[];
}>, "acs_systems">, "acs_systems">
listAcsUsers
- listAcsUsers(body?): SeamHttpRequest<SetNonNullable<Required<{
acs_users: {
access_schedule?: {
ends_at: null | string;
starts_at: string;
};
acs_system_id: string;
acs_user_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
})[];
external_type?:
| "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: true;
is_suspended?: boolean;
latest_desired_state_synced_with_provider_at?: string;
phone_number?: string;
user_identity_email_address?: null | string;
user_identity_full_name?: null | string;
user_identity_id?: string;
user_identity_phone_number?: null | string;
warnings: ({
created_at: string;
message: string;
warning_code: "being_deleted";
} | {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
})[];
workspace_id: string;
}[];
}>, "acs_users">, "acs_users"> Parameters
Optional
body: {
user_identity_id: string;
}
Returns SeamHttpRequest<SetNonNullable<Required<{
acs_users: {
access_schedule?: {
ends_at: null | string;
starts_at: string;
};
acs_system_id: string;
acs_user_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
})[];
external_type?:
| "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: true;
is_suspended?: boolean;
latest_desired_state_synced_with_provider_at?: string;
phone_number?: string;
user_identity_email_address?: null | string;
user_identity_full_name?: null | string;
user_identity_id?: string;
user_identity_phone_number?: null | string;
warnings: ({
created_at: string;
message: string;
warning_code: "being_deleted";
} | {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
})[];
workspace_id: string;
}[];
}>, "acs_users">, "acs_users">
removeAcsUser
- removeAcsUser(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
acs_user_id: string;
user_identity_id: string;
}acs_user_id: string
user_identity_id: string
revokeAccessToDevice
- revokeAccessToDevice(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
device_id: string;
user_identity_id: string;
}device_id: string
user_identity_id: string
update
- update(body?): SeamHttpRequest<void, undefined>
Parameters
Optional
body: {
email_address?: null | string;
full_name?: null | string;
phone_number?: null | string;
user_identity_id: string;
user_identity_key?: null | string;
}Optional
email_address?: null | string
Optional
full_name?: null | string
Optional
phone_number?: null | string
user_identity_id: string
Optional
user_identity_key?: null | string
updateClientSessionToken
- updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
Static
fromApiKey
- fromApiKey(apiKey, options?): SeamHttpUserIdentities
Static
fromClient
- fromClient(client, options?): SeamHttpUserIdentities
Static
fromClientSessionToken
- fromClientSessionToken(clientSessionToken, options?): SeamHttpUserIdentities
Static
fromConsoleSessionToken
- fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpUserIdentities
Static
fromPersonalAccessToken
- fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpUserIdentities
Static
fromPublishableKey
- fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpUserIdentities>
ID of the desired ACS user.