v2

latestOpenAPI 3.1.02026-07-26274982.6 KB

Lock Sessions

Lock or unlock

Start a new lock session or complete (unlock) the active session. User IDs (target and keyholders) are validated against your accessible users before the action is performed.

post/lkbx/session/current

Request body

action'lock' | 'unlock' required

Action to perform

lockSettingsIdinteger

Lock template ID (for lock action)

keyholderIdsinteger[]

User IDs to assign as keyholders (for lock action). All IDs must be users you have access to.

targetUserIdinteger

User to lock/unlock (defaults to authenticated user). Must be a user you have access to.

isTestLockboolean

Override test lock setting from template. When true, the lock owner can unlock without a keyholder. Only used with lock action.

Response

Lock session completed

oktrue required