Class SeamHttpAcsCredentials

constructor

• new SeamHttpAcsCredentials(apiKeyOrOptions?): SeamHttpAcsCredentials

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsCredentials

client

Readonly defaults

assign

• assign(body?): Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

• Parameters

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

    • acs_credential_id: string

    • acs_user_id: string

  Returns Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

create

• create(body?): Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        access_method: "code" | "card" | "mobile_key";
        acs_user_id: string;
        assa_abloy_credential_service_mobile_endpoint_id?: string;
        card_format?: "TLCode" | "rfid48";
        code?: string;
        ends_at?: string;
        external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
        is_multi_phone_sync_credential?: boolean;
        is_override_key?: boolean;
        starts_at?: string;
    }

    • access_method: "code" | "card" | "mobile_key"

    • acs_user_id: string

    • Optional assa_abloy_credential_service_mobile_endpoint_id?: string

    • Optional card_format?: "TLCode" | "rfid48"

    • Optional code?: string

    • Optional ends_at?: string

    • Optional external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card"

    • Optional is_multi_phone_sync_credential?: boolean

    • Optional is_override_key?: boolean

    • Optional starts_at?: string

  Returns Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_credential_id: string;
    }

    • acs_credential_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        acs_credential_id: string;
    }

    • acs_credential_id: string

  Returns Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: AcsCredentialsListParams

  Returns Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }[]>

unassign

• unassign(body?): Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

• Parameters

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

    • acs_credential_id: string

    • acs_user_id: string

  Returns Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

update

• update(body?): Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        acs_credential_id: string;
        code: string;
    }

    • acs_credential_id: string

    • code: string

  Returns Promise<{
      access_method: "code" | "card" | "mobile_key";
      acs_credential_id: string;
      acs_credential_pool_id?: string;
      acs_system_id: string;
      acs_user_id?: string;
      code?: null | string;
      created_at: string;
      display_name: string;
      ends_at?: string;
      external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
      external_type_display_name?: string;
      starts_at?: string;
      workspace_id: string;
  }>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsCredentials

• Parameters

  • apiKey: string

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

  Returns SeamHttpAcsCredentials

Static fromClient

• fromClient(client, options?): SeamHttpAcsCredentials

• Parameters

  • client: AxiosInstance

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

  Returns SeamHttpAcsCredentials

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsCredentials

• Parameters

  • clientSessionToken: string

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

  Returns SeamHttpAcsCredentials

Static fromConsoleSessionToken

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

• Parameters

  • consoleSessionToken: string

  • workspaceId: string

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

  Returns SeamHttpAcsCredentials

Static fromPersonalAccessToken

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

• Parameters

  • personalAccessToken: string

  • workspaceId: string

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

  Returns SeamHttpAcsCredentials

Static fromPublishableKey

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

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsCredentials>