Reference · built on requestConnectorAccess control & video

LenelS2 OnGuard

Logged events, cardholders, badges, and reader status from LenelS2 OnGuard through OpenAccess, with badge, door, and lockdown actions.

About

OnGuard is the LenelS2 access control system for enterprise sites, run on the customer's own servers. OpenAccess is its licensed REST interface: the LS OpenAccess service fronts OnGuard objects such as Lnl_Cardholder, Lnl_Badge, Lnl_Reader, Lnl_Panel, and Lnl_LoggedEvent at /api/access/onguard/openaccess, and the LS Message Broker service delivers events to subscribers over WebSocket.

Through Fibric, an operator subscribes to logged events, reads the cardholder and badge behind each one, and proposes a badge change, a door open, or a lockdown. After your approval the request is sent once, and the receipt lists each change with the way to undo it.

This is a reference listing. It documents what Fibric would read from LenelS2 OnGuard 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

  • Logged events such as access granted, access denied, door held open, and door forced open, through get logged_events and event subscriptions
  • Cardholders, visitors, badges, and access level assignments through GET /instances?type_name=Lnl_Cardholder, Lnl_Badge, and Lnl_AccessLevelAssignment
  • Readers and panels as Lnl_Reader and Lnl_Panel, including lockdown state on readers
  • Event subscriptions, durable or transient, with event filters, delivered through the LS Message Broker and LS Web Event Bridge
  • License feature availability and counts through get feature_availability and get licensedata
  • Badge print requests, mobile credential issuance, and badge printers

Proposed actions

  • Target capability: propose adding, modifying, or deleting a cardholder or badge through add instances, modify instances, and delete instances
  • Target capability: propose opening a door with execute_method OpenDoor on an Lnl_Reader, or changing its mode with SetMode
  • Target capability: propose activating or deactivating a lockdown group through LockdownGroupActivate and LockdownGroupDeactivate on Lnl_DeviceGroup
  • Target capability: propose an access level change through put access_level, or issuing a mobile credential through add badge issue_mobile_credential

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

What you can build

  • Revoke a badge the day someone leaves

    A leaver record in HR or your identity provider triggers a proposal to deactivate the person's Lnl_Badge and remove access level assignments. You approve; the receipt names each change.

    With Access Offboarding, Badge Hygiene

  • Act on door forced and door held events

    Door forced open and door held open events arrive through a durable subscription. The operator reads the reader and cardholder, then proposes an alert with the event details attached.

    With Door Held Open

  • Spot access patterns that break policy

    Access granted and denied events are grouped by cardholder, reader, and hour. Repeated denials or entries outside a person's schedule are proposed for review.

    With Access Anomaly, After-Hours Audit

  • Expire contractor badges on the contract end date

    The operator compares badge activation and deactivation dates against contract records and proposes modify instances calls for badges that outlive their contract.

    With Contractor Credentials

Requirements

  • An OnGuard system licensed for OpenAccess, with the LS OpenAccess and LS Message Broker services running and SSL enabled
  • A unique application ID and license for your integration, requested from LenelS2 by email with the subject OA Dev Kit Request
  • An OnGuard user, internal or directory-based, whose permissions cover the objects and methods the operator touches
  • Network reach to the OnGuard web service on port 8080, and a WebSocket path for event delivery
Authentication
An OnGuard user account logged in through POST /authentication with user_name, password, and directory_id, plus an Application-Id header; later calls carry the returned Session-Token or the OASessionID cookie.

Limits

  • Paging is always applied: page_size defaults to 20 and cannot exceed 100 instances per request
  • A durable event subscription must be renewed with modify event_subscriptions every seven days, a transient one every 24 hours, or it is deleted
  • Sessions expire 8 hours after creation by default; get keepalive prevents idle timeout
  • Internal accounts lock after three failed logins; OpenAccess has no outbound webhook, so events arrive through the message broker

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 LenelS2 OnGuard ↗

Questions and answers

How do events reach an integration from OnGuard?
Through event subscriptions. You create one with add event_subscriptions, optionally with a filter, and events flow through the LS Message Broker and LS Web Event Bridge over WebSocket. Durable subscriptions keep events while you are offline; transient ones do not. Both must be renewed with modify event_subscriptions to stay active.
What is the Application-Id header?
Every application using OpenAccess needs its own application ID and license from LenelS2. The Application-Id header identifies your integration on each request. Without a valid ID, POST /authentication returns 401 with the message that you are not licensed for OpenAccess.
Can OpenAccess open a door?
Yes. The execute_method call runs a method on an instance, and Lnl_Reader declares OpenDoor and SetMode. The OnGuard user must hold the matching permission; lockdown activation and deactivation on a reader check its MNT_CTRL_LOCKDOWN_ACTIVATION and MNT_CTRL_LOCKDOWN_DEACTIVATION permissions.
Ask about LenelS2 OnGuard

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.