Skip to main content
Connect Open Options Flex to KODE OS for access control data integration

Overview

Use this integration to connect your Open Options Flex access control system to KODE OS. You can discover devices and points and collect sensor and non-sensor access data through REST.

Supported Capabilities

  • Discover Devices & Points
  • Collect Sensor Data
  • Collect Non-Sensor Data

Prerequisites

  • An active account with Open Options Flex and access to their API or developer portal
  • OAuth client credentials (Client ID and Client Secret) from the Open Options Flex developer portal
  • KODE OS environment with access to Data Sources

Generate API Credentials

  1. Log in to the Open Options Flex developer portal or admin console
  2. Navigate to the API or developer settings section
  3. Create a new API application or client
  4. Note the Client ID and Client Secret — you will need these when configuring the connector in KODE OS
  5. Note the Auth URL for OAuth token exchange

Configure Connector in KODE OS

  1. Navigate to Data Sources in your building
  2. Click API Catalog and search for Open Options Flex
  3. Click + Add Datasource
  4. Fill in the fields below and complete the three-page setup flow

Discover Devices and Points

After configuring the connector, click Discover on the connector detail page. KODE OS will query the Open Options Flex system and return a list of available devices and their data points. Review the discovered items and select the devices you want to register in KODE OS. For more details on the discovery process, see the Discovery guide.

Devices and Points

When you discover devices from Open Options Flex, KODE OS maps them to the following device types and data points:

Access Controller

Canonical Type: default

What Data You Get

Point History

Time-series readings including isMasked, mode, active, forcedOpen, forceMasked, heldOpen, heldMasked, fault, and 1 more, collected at regular intervals from connected devices

Alarms

Alert and fault notifications including alarm name, priority, status, timestamps, device association, and acknowledgment state KODE OS maps Open Options Flex data to these standard fields:

Polling Schedule

  • Point History — Default polling: 1 minutes (min: 1 minutes, max: 1 hours)
  • Alarm — Default polling: 1 days (min: 1 days, max: 1 days)
For more details on collection modes, see the Data Collection guide.

Use Cases

Once connected, this integration enables you to:
  • Centralize access event monitoring across all entry points and zones
  • Generate audit trails for security compliance and investigation
  • Correlate access patterns with occupancy and energy data for building optimization

Troubleshooting

Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Ensure the Client ID and Client Secret match the values from the Open Options Flex developer portal.
Verify the connector credentials have sufficient permissions in the Open Options Flex system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Open Options Flex API.
Last modified on March 29, 2026