Class SeamHttpUserIdentities

constructor

• new SeamHttpUserIdentities(apiKeyOrOptions?): SeamHttpUserIdentities

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentities

client

Readonly defaults

enrollmentAutomations

• get enrollmentAutomations(): SeamHttpUserIdentitiesEnrollmentAutomations

• Returns SeamHttpUserIdentitiesEnrollmentAutomations

addAcsUser

• addAcsUser(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_user_id: string;
        user_identity_id: string;
    }

    • acs_user_id: string

    • user_identity_id: string

  Returns Promise<void>

create

• create(body?): Promise<{
      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;
  }>

• 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 Promise<{
      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;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      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;
  }>

• Parameters

  • Optional body: UserIdentitiesGetParams

  Returns Promise<{
      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;
  }>

grantAccessToDevice

• grantAccessToDevice(body?): Promise<void>

• Parameters

  • Optional body: {
        device_id: string;
        user_identity_id: string;
    }

    • device_id: string

    • user_identity_id: string

  Returns Promise<void>

list

• list(body?): Promise<{
      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;
  }[]>

• Parameters

  • Optional body: {
        credential_manager_acs_system_id?: string;
    }

    • Optional credential_manager_acs_system_id?: string

  Returns Promise<{
      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;
  }[]>

listAccessibleDevices

• listAccessibleDevices(body?): Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      custom_metadata?: Record<string, null | 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          has_direct_power?: boolean;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          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: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      } & {
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          avigilon_alta_metadata?: {
              entry_name: string;
              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: null | string;
          };
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              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_metadata?: {
              device_name: string;
              honeywell_device_id: string;
          };
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: null | number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "doorking" | "bridge";
          };
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          tedee_metadata?: {
              bridge_id: number;
              bridge_name: string;
              device_id: number;
              device_model: string;
              device_name: string;
              serial_number: string;
          };
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...);
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      custom_metadata?: Record<string, null | 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          has_direct_power?: boolean;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          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: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      } & {
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          avigilon_alta_metadata?: {
              entry_name: string;
              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: null | string;
          };
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              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_metadata?: {
              device_name: string;
              honeywell_device_id: string;
          };
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: null | number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "doorking" | "bridge";
          };
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          tedee_metadata?: {
              bridge_id: number;
              bridge_name: string;
              device_id: number;
              device_model: string;
              device_name: string;
              serial_number: string;
          };
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...);
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

listAcsSystems

• listAcsSystems(body?): Promise<{
      acs_system_id: string;
      connected_account_ids: string[];
      created_at: string;
      external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service";
      external_type_display_name: string;
      image_alt_text: string;
      image_url: string;
      name: string;
      system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service";
      system_type_display_name: string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns Promise<{
      acs_system_id: string;
      connected_account_ids: string[];
      created_at: string;
      external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service";
      external_type_display_name: string;
      image_alt_text: string;
      image_url: string;
      name: string;
      system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service";
      system_type_display_name: string;
      workspace_id: string;
  }[]>

listAcsUsers

• listAcsUsers(body?): Promise<{
      access_schedule?: {
          ends_at: string;
          starts_at: string;
      };
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      phone_number?: string;
      user_identity_email_address?: string;
      user_identity_id?: string;
      user_identity_phone_number?: string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns Promise<{
      access_schedule?: {
          ends_at: string;
          starts_at: string;
      };
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      phone_number?: string;
      user_identity_email_address?: string;
      user_identity_id?: string;
      user_identity_phone_number?: string;
      workspace_id: string;
  }[]>

removeAcsUser

• removeAcsUser(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_user_id: string;
        user_identity_id: string;
    }

    • acs_user_id: string

    • user_identity_id: string

  Returns Promise<void>

revokeAccessToDevice

• revokeAccessToDevice(body?): Promise<void>

• Parameters

  • Optional body: {
        device_id: string;
        user_identity_id: string;
    }

    • device_id: string

    • user_identity_id: string

  Returns Promise<void>

update

• update(body?): Promise<void>

• 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

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpUserIdentities

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpUserIdentities

Static fromClient

• fromClient(client, options?): SeamHttpUserIdentities

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpUserIdentities

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpUserIdentities

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpUserIdentities

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpUserIdentities

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpUserIdentities

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpUserIdentities

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpUserIdentities

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpUserIdentities>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpUserIdentities>