Reference · built on requestConnectorAccess control & video

Salto KS

Sites, locks, users, keys, PINs, access groups, entries, and incidents from Salto KS through the Connect API.

About

Salto KS is SALTO Systems' cloud access control service for Salto electronic locks, connected through an IQ gateway at each site. The Connect API, REST with OData query syntax, is the same backbone the KS web and mobile apps use: sites, IQs, locks, repeaters, users, keys, PINs, access groups with time schedules, entries, incidents, audit, pods, lockers, and vouchers.

Through Fibric, an operator reads entries and incidents per site, checks access group membership, and proposes a remote opening, an office mode change, a key block, or an access group edit. You approve, and the change is applied once with a record of who asked and why.

This is a reference listing. It documents what Fibric would read from Salto KS and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Entries through GET /v1.1/sites/{site_id}/entries with access_by, access_detail, event_category, and exit_requested, or exported from /v1.2 entries/export
  • Incidents through GET /v1.1/sites/{site_id}/incidents and their export, with IQ, lock, and event detail
  • Audit entries through GET /v1.1/sites/{site_id}/audit when the site subscription includes the Activity Log feature
  • Locks, floors, repeaters, and IQs with signal strength, software versions, and hardware tree
  • Site users, their keys, PINs, license plate credentials, and access groups
  • Access groups with their locks, users, floors, and time schedules
  • Site subscription details and features, and a time and attendance report delivered by email as CSV

Proposed actions

  • Target capability: propose a remote opening or office mode change through PATCH /v1.2/sites/{site_id}/locks/{id}/locking with a locked_state
  • Target capability: propose blocking or unblocking a user's key, or toggling its offline access, through PATCH /v1.2/sites/{site_id}/users/{site_user_id}/keys/{id}
  • Target capability: propose adding or removing a user or lock in an access group through the /v1.2 access_groups endpoints
  • Target capability: propose an entry or incident notification rule for a site user through the notification rule endpoints
  • Target capability: propose a new site user, a resent invitation, or a PIN update

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Open a door for an expected visitor

    After a host confirms, the operator proposes PATCH locking with the open locked_state on the lobby lock, then records the entry that follows.

    With Visitor Pre-Registration, Contractor Credentials

  • Block keys for departed staff

    When someone leaves your directory, the operator lists their keys across sites and proposes blocked: true on each, plus removal from access groups, in one approval.

    With Access Offboarding, Access Review

  • Turn incidents into tickets

    New incidents per site are checked against open work. The operator drafts a ticket with the lock, IQ, and event detail and proposes it.

    With Incident Draft, Alarm Triage

Requirements

  • A Client ID and Client Secret obtained from your local Salto Business Unit
  • A system user with the site_admin role, added to every site the integration will manage
  • Sites whose subscription includes the features an endpoint validates, such as Activity Log for audit retention settings
  • Permissions on that user matching each call, for example ENTRIES_VIEW_ALL, INCIDENTS_VIEW_ALL, or REMOTE_LOCKING_ALL
Authentication
OpenID Connect at identity.eu.my-clay.com; backend integrations use the password flow with a client ID, client secret, a system user, and scope user_api.full_access, then send the access token as a Bearer JWT.

Limits

  • Access tokens last one hour; refresh tokens last multiple weeks and can be revoked, and need scope offline_access to be issued
  • Entries and incidents carry an expiration_date_time after which the event is deleted
  • Paging uses OData $top and $skip, with a CLP-Continuation-Token header for entries and incidents
  • Some endpoints are marked Feature Validation and reject calls when the site subscription lacks the feature

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Salto KS ↗

Questions and answers

Which OAuth flow does a server integration use?
The password flow. A non-interactive client POSTs grant_type=password with a pre-configured system user, client_id, client_secret, and scope user_api.full_access to the Identity Provider's /connect/token endpoint. Interactive apps use authorization_code with PKCE. Both may use refresh_token.
Does Salto KS push events to a URL?
The Connect API reference documents entry and incident notification rules that send push or email to a site user, and entries and incidents endpoints with OData filters for polling. No outbound webhook endpoint appears in the reference.
Can the API open a lock?
PATCH /v1.2/sites/{site_id}/locks/{id}/locking opens the lock or puts it in office mode when the user has REMOTE_LOCKING_ALL or REMOTE_OFFICEMODE_ALL permissions. locked_state takes a RequestLockStates value such as locked, office_mode, or the open state, and an OTP may be required.
Ask about Salto KS

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.