Class SeamHttpAcsUsersUnmanaged

constructor

• new SeamHttpAcsUsersUnmanaged(apiKeyOrOptions?): SeamHttpAcsUsersUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsersUnmanaged

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_user: {
          access_schedule?: {
              ends_at: null | string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          connected_account_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;
              }
              | {
                  created_at: string;
                  error_code: "latch_conflict_with_resident_user";
                  message: string;
              })[];
          external_type?:
              | "pti_user"
              | "brivo_user"
              | "hid_credential_manager_user"
              | "salto_site_user"
              | "latch_user"
              | "dormakaba_community_user"
              | "salto_space_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_managed: false;
          is_suspended?: boolean;
          last_successful_sync_at: null | string;
          pending_mutations?: (
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "creating";
              }
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "deleting";
              }
              | {
                  created_at: string;
                  from: {
                      email_address?: (...) | (...) | (...);
                      full_name?: (...) | (...) | (...);
                      phone_number?: (...) | (...) | (...);
                  };
                  message: string;
                  mutation_code: "updating_user_information";
                  to: {
                      email_address?: (...) | (...) | (...);
                      full_name?: (...) | (...) | (...);
                      phone_number?: (...) | (...) | (...);
                  };
              }
              | {
                  created_at: string;
                  from: {
                      ends_at: (...) | (...);
                      starts_at: (...) | (...);
                  };
                  message: string;
                  mutation_code: "updating_access_schedule";
                  to: {
                      ends_at: (...) | (...);
                      starts_at: (...) | (...);
                  };
              }
              | {
                  created_at: string;
                  from: {
                      is_suspended: boolean;
                  };
                  message: string;
                  mutation_code: "updating_suspension_state";
                  to: {
                      is_suspended: boolean;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      acs_access_group_id: (...) | (...);
                  };
                  message: string;
                  mutation_code: "updating_group_membership";
                  to: {
                      acs_access_group_id: (...) | (...);
                  };
              })[];
          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";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_user";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "latch_resident_user";
              })[];
          workspace_id: string;
      };
  }>, "acs_user">, "acs_user">

• Parameters

  • Optionalparams: {
        acs_user_id: string;
    }

    • acs_user_id: string

      ID of the unmanaged access system user that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_user: {
          access_schedule?: {
              ends_at: null | string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          connected_account_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;
              }
              | {
                  created_at: string;
                  error_code: "latch_conflict_with_resident_user";
                  message: string;
              })[];
          external_type?:
              | "pti_user"
              | "brivo_user"
              | "hid_credential_manager_user"
              | "salto_site_user"
              | "latch_user"
              | "dormakaba_community_user"
              | "salto_space_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_managed: false;
          is_suspended?: boolean;
          last_successful_sync_at: null | string;
          pending_mutations?: (
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "creating";
              }
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "deleting";
              }
              | {
                  created_at: string;
                  from: {
                      email_address?: (...) | (...) | (...);
                      full_name?: (...) | (...) | (...);
                      phone_number?: (...) | (...) | (...);
                  };
                  message: string;
                  mutation_code: "updating_user_information";
                  to: {
                      email_address?: (...) | (...) | (...);
                      full_name?: (...) | (...) | (...);
                      phone_number?: (...) | (...) | (...);
                  };
              }
              | {
                  created_at: string;
                  from: {
                      ends_at: (...) | (...);
                      starts_at: (...) | (...);
                  };
                  message: string;
                  mutation_code: "updating_access_schedule";
                  to: {
                      ends_at: (...) | (...);
                      starts_at: (...) | (...);
                  };
              }
              | {
                  created_at: string;
                  from: {
                      is_suspended: boolean;
                  };
                  message: string;
                  mutation_code: "updating_suspension_state";
                  to: {
                      is_suspended: boolean;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      acs_access_group_id: (...) | (...);
                  };
                  message: string;
                  mutation_code: "updating_group_membership";
                  to: {
                      acs_access_group_id: (...) | (...);
                  };
              })[];
          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";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_user";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "latch_resident_user";
              })[];
          workspace_id: string;
      };
  }>, "acs_user">, "acs_user">

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_users: {
          access_schedule?: {
              ends_at: null | string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          connected_account_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;
              }
              | {
                  created_at: string;
                  error_code: "latch_conflict_with_resident_user";
                  message: string;
              })[];
          external_type?:
              | "pti_user"
              | "brivo_user"
              | "hid_credential_manager_user"
              | "salto_site_user"
              | "latch_user"
              | "dormakaba_community_user"
              | "salto_space_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_managed: false;
          is_suspended?: boolean;
          last_successful_sync_at: null | string;
          pending_mutations?: (
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "creating";
              }
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "deleting";
              }
              | {
                  created_at: string;
                  from: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
                  message: string;
                  mutation_code: "updating_user_information";
                  to: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      ends_at: ...;
                      starts_at: ...;
                  };
                  message: string;
                  mutation_code: "updating_access_schedule";
                  to: {
                      ends_at: ...;
                      starts_at: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      is_suspended: ...;
                  };
                  message: string;
                  mutation_code: "updating_suspension_state";
                  to: {
                      is_suspended: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      acs_access_group_id: ...;
                  };
                  message: string;
                  mutation_code: "updating_group_membership";
                  to: {
                      acs_access_group_id: ...;
                  };
              })[];
          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";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_user";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "latch_resident_user";
              })[];
          workspace_id: string;
      }[];
  }>, "acs_users">, "acs_users">

• Parameters

  • Optionalparams: {
        acs_system_id?: string;
        limit?: number;
        user_identity_email_address?: string;
        user_identity_id?: string;
        user_identity_phone_number?: string;
    }

    • Optionalacs_system_id?: string

      ID of the access system for which you want to retrieve all unmanaged access system users.

    • Optionallimit?: number

      Number of unmanaged access system users to return.

    • Optionaluser_identity_email_address?: string

      Email address of the user identity for which you want to retrieve all unmanaged access system users.

    • Optionaluser_identity_id?: string

      ID of the user identity for which you want to retrieve all unmanaged access system users.

    • Optionaluser_identity_phone_number?: string

      Phone number of the user identity for which you want to retrieve all unmanaged access system users.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_users: {
          access_schedule?: {
              ends_at: null | string;
              starts_at: string;
          };
          acs_system_id: string;
          acs_user_id: string;
          connected_account_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;
              }
              | {
                  created_at: string;
                  error_code: "latch_conflict_with_resident_user";
                  message: string;
              })[];
          external_type?:
              | "pti_user"
              | "brivo_user"
              | "hid_credential_manager_user"
              | "salto_site_user"
              | "latch_user"
              | "dormakaba_community_user"
              | "salto_space_user";
          external_type_display_name?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          is_managed: false;
          is_suspended?: boolean;
          last_successful_sync_at: null | string;
          pending_mutations?: (
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "creating";
              }
              | {
                  created_at: string;
                  message: string;
                  mutation_code: "deleting";
              }
              | {
                  created_at: string;
                  from: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
                  message: string;
                  mutation_code: "updating_user_information";
                  to: {
                      email_address?: ...;
                      full_name?: ...;
                      phone_number?: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      ends_at: ...;
                      starts_at: ...;
                  };
                  message: string;
                  mutation_code: "updating_access_schedule";
                  to: {
                      ends_at: ...;
                      starts_at: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      is_suspended: ...;
                  };
                  message: string;
                  mutation_code: "updating_suspension_state";
                  to: {
                      is_suspended: ...;
                  };
              }
              | {
                  created_at: string;
                  from: {
                      acs_access_group_id: ...;
                  };
                  message: string;
                  mutation_code: "updating_group_membership";
                  to: {
                      acs_access_group_id: ...;
                  };
              })[];
          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";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_user";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "latch_resident_user";
              })[];
          workspace_id: string;
      }[];
  }>, "acs_users">, "acs_users">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromClient

• fromClient(client, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAcsUsersUnmanaged>