Input lists

Locksmith uses input lists for managed sets of bulk inputs – pieces of data that a visitor must supply in order to gain access. They're useful when you have more than just a few inputs – perhaps you need to allow a set of 500,000 passcodes, for example.

Input lists are synchronized from external sources, configured with a URL – perhaps a text file on your own server, a Google Sheets document, an Excel file on Google Drive, or even a JSON array provided by a Mechanic cache endpoint. Synchronizing with an external source allows you to manage this bulk data however you like, without being constrained to Locksmith's own data management.

Configuration

Input lists are configured in your Locksmith account settings. To find this area, open Locksmith's home screen, then scroll to the end of the page, and click the "View all settings" button. Input lists are available in the "Advanced" area.

Options

An input list has three options:

  • Name
  • Source URL (must be either unauthenticated, or must be a Google Drive file or Sheets document that has been shared with input-lists@locksmith-app.iam.gserviceaccount.com)
  • Input values are case-sensitive (enable to require an exact case match)

Supported file formats

Source files may be of the following formats:

  • TXT (one input value per line)
  • CSV (a single column of input values, one value per row)
  • JSON (an array of strings)
  • Google Sheets (a document having a single column of input values, one value per row)
  • Microsoft Excel XLSX (a spreadsheet having a single column of input values, one per row)

Syncing

Input lists are automatically synchronized on a regular basis (currently at midnight UTC, subject to change without notice). Input lists may be also synchronized manually, by using the "Sync input list" button for the respective list.

Any new items found in the source file will be added to Locksmith's copy of the list. Any items that are no longer found in the source file will be removed from Locksmith's copy of the list.

Usage

Once at least one input list has created, you may use it by choosing the "Permit if the customer gives a passcode from an input list…" option, when configuring a new key condition. Aside from the fact that passcodes are sourced from an input list, this key condition is otherwise behaviorally the same as a standard passcode key condition.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.