Class SeamHttpUserIdentities

constructor

• new SeamHttpUserIdentities(apiKeyOrOptions?): SeamHttpUserIdentities

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentities

client

Readonly defaults

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;
      user_identity_id: string;
      user_identity_key: null | string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        email_address?: null | string;
        full_name?: null | string;
        user_identity_key?: null | string;
    }

    • Optional email_address?: null | string

    • Optional full_name?: null | string

    • Optional user_identity_key?: null | string

  Returns Promise<{
      created_at: string;
      display_name: string;
      email_address: null | string;
      full_name: null | string;
      user_identity_id: string;
      user_identity_key: null | string;
      workspace_id: string;
  }>

get

• get(body?): Promise<{
      created_at: string;
      display_name: string;
      email_address: null | string;
      full_name: 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;
      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(params?): Promise<{
      created_at: string;
      display_name: string;
      email_address: null | string;
      full_name: null | string;
      user_identity_id: string;
      user_identity_key: null | string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional params: {}

  Returns Promise<{
      created_at: string;
      display_name: string;
      email_address: null | string;
      full_name: null | string;
      user_identity_id: string;
      user_identity_key: null | string;
      workspace_id: string;
  }[]>

listAccessibleDevices

• listAccessibleDevices(body?): Promise<{
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: ({ online: boolean; name: string; model: { display_name: string; manufacturer_display_name: string; offline_access_codes_supported?: boolean | undefined; online_access_codes_supported?: boolean | undefined; accessory_keypad_supported?: boolean | undefined; }; ... 10 more ...; supports_offline_access_codes?: boolean |...) & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        user_identity_id: string;
    }

    • user_identity_id: string

  Returns Promise<{
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: ({ online: boolean; name: string; model: { display_name: string; manufacturer_display_name: string; offline_access_codes_supported?: boolean | undefined; online_access_codes_supported?: boolean | undefined; accessory_keypad_supported?: boolean | undefined; }; ... 10 more ...; supports_offline_access_codes?: boolean |...) & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      };
      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;
      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;
      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;
      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;
      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>

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>