FoyerDevelopers

Generated · Live registry

smart-locks tools

5 tools in this domain, generated from the running registry.

All tool domains

smart-locks.delete

writesconfirm

Delete a smart-lock assignment by id. Tenant-scoped: only locks owned by the current tenant can be deleted. Cascade-deletes any access_codes rows for that lock.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

smart-locks.doors

read-only

List the tenant's configured doors (id, name, provider, enabled). Use a door's id with smart-locks.unlock.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
doorsarray of objectyes
doors.idstringyes
doors.namestringyes
doors.providerstringyes
doors.lockNamestring · nullableyes
doors.enabledbooleanyes
doors.positionnumberyes

smart-locks.list

read-only

List smart-lock assignments for this tenant. Returns per-room lock metadata (type, label, active). Credentials are NOT returned by this tool — use the operator settings UI to edit them.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
locksarray of objectyes
locks.idstringyes
locks.roomIdstringyes
locks.roomNamestring · nullableyes
locks.lockTypeenumyesOne of: nuki, ttlock, salto, dormakaba, mock
locks.labelstringyes
locks.credentialsHintstring · nullableyes
locks.activebooleanyes

smart-locks.unlock

writesconfirm

Open one of the tenant's configured doors now (any provider — Nuki Web API, TTLock Cloud, Tedee API). Pass doorId (see smart-locks.doors) or omit it to open the default door. Audit-logged.

Input parameters

FieldTypeRequiredNotes
doorIdstringno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
smartlockNamestring · nullableyes

smart-locks.upsert

writesconfirm

Create or update a smart-lock assignment for a room. Pass `id` to update an existing lock, or omit it to insert (unique per tenant+room — upsert on conflict).

Input parameters

FieldTypeRequiredNotes
idstringno
roomIdstringyes
lockTypeenumyesOne of: nuki, ttlock, salto, dormakaba, mock
labelstringyes
credentialsobjectyes
activebooleannoDefault: true

Output fields

FieldTypeRequiredNotes
idstringyes