Added​

Config Endpoint​

Use this to populate timezone selection that matches what the server accepts for PACS and account configuration.

Added​

Axis A1610 Support​

Door monitor and REX pin assignments are now driven by configurable IO-pin layouts so mappings are correct across A16xx variants. A1610 controllers are auto-stamped with the Axis-standard layout.

Controller Type Definition​

Changed​

Event Search Reason Presets​

Event search accepts a named reason preset: DEFAULT, ALL, or ALL_NO_HIDDEN. An explicit reason list takes precedence over the preset. The default curated reason set was adjusted (one reason removed).

Fixed​

• Cursor pagination is now stable for events sharing the same millisecond (ID-based ordering).
• Controller sync continues processing remaining items when an individual item hits a non-fatal error.

Added​

Mobile Client Endpoints​

PACS-scoped endpoints for inspecting mobile clients and their enrolled credentials:

Sharing and Transfer Permissions​

Two new permissions, MANAGE_SHARING and MANAGE_TRANSFER, give finer-grained control over door sharing and transfer. Create and update flows expand shared groups into their underlying doors and enforce these permissions per door. The permission tree now includes a sandbox indicator on account and PACS nodes.

Changed​

Timezone and Datetime Handling​

• Absolute timestamps use ISO-8601 UTC instants with a trailing Z. Local wall-clock fields use a local date-time format.
• PACS and account timezone is now optional on creation and defaults to UTC when omitted.

Added​

SCIM 2.0 API​

A SCIM 2.0 provisioning endpoint for Users and Groups (roles), enabling automated user lifecycle from an identity provider.

• Integrations are configured and enabled/disabled per PACS.
• Authentication uses a Bearer API key scoped to the SCIM integration.
• Compatibility modes accommodate provider-specific behavior.
• All provisioning operations are recorded in the audit trail, with API-key usage throttling.

Source Tracking​

User and role responses now indicate whether the entity was created MANUALly or via SCIM.

Added​

API Key Rotation​

Rotation accepts an optional graceSeconds to keep the previous key valid during an overlap window. The response returns the new raw key (the full value is shown only on create and rotate) plus previousKeyPrefix and previousValidUntil. Host API keys can be rotated the same way.

Changed​

Door Availability and Permissions (v3)​

With Accept-Version: 3.0, door responses include an availability context and a permissions set. Access actions and override actions are gated by distinct permissions, and live-status fields are suppressed when the caller lacks VIEW_STATUS. v3 list endpoints also return upcoming and passed lease doors.

Fixed​

Door Group Privilege Updates​

Updating a door group now preserves managed permissions while allowing unmanaged privileges to be replaced or cleared.

Changed​

Nullable description Field​

The description field is now nullable across all resources that have it, including hubs, domains, doors, controllers, accounts, administrators, roles, schedules, and others.

Previous behavior: Omitting description on create stored "". Responses always returned "" for unset values.

New behavior:

On create and update, description can be omitted (remains null), set to null explicitly, or set to a string value.

v3 behavior will become the default in a future release. See the field semantics guide for details.

Added​

Administrators and Service Accounts​

The legacy /officers endpoints are now deprecated. Identity management is split into:

Administrators use a capacities array instead of the legacy systemOwner/owns/administrates fields. Service accounts can manage passwords via POST /service-accounts/{id}/auth/password.

API keys come in two types: PAT (personal access token for administrators) and SERVICE_ACCOUNT (linked to a service account). API keys cannot manage other keys, administrators, or service accounts.

Event Metadata​

Door Override Actions​

New endpoints for controlling door lock overrides programmatically:

Supported actions: LOCK, UNLOCK, BLOCK, DOUBLE_LOCK, RELEASE. Each override accepts an optional priority (HIGH or NORMAL, defaults to HIGH).

Overrides are persisted immediately and synced to the controller asynchronously. Use the waitSeconds query parameter (0–15) to block until the sync completes. The response includes an operationId for polling status if you prefer async — status can be PENDING, COMPLETED, or FAILED.

PIN Management​

PIN codes can be reset or regenerated via the API.

Changed​

Doors (v3): Null for unconfigured values​

With Accept-Version: 3.0, door endpoints return null for openTooLong and preAlarm when not explicitly configured, instead of returning system defaults.

Deprecated​

Officers Endpoints​

All /officers endpoints are deprecated. Use /administrators for human users and /service-accounts for non-human identities. See API documentation for migration details.

Added​

Account Settings API​

Account owners can retrieve and update account-level settings:

Settings include mfaRequired to enforce MFA for all administrators.

Door NFC Tags​

Doors now support tagId and secondaryTagId fields for NFC-triggered remote open. Users tap their phone on an NFC tag to access doors.

Controller Diagnostics​

New diagnostic endpoints for troubleshooting controllers:

Mobile Client Tracking​

Mobile clients now track lastSignedInEmail for identifying which user last signed in on a device.

Door Group Owner Field​

Door groups now include an owner field showing the owning system.

Fixed​

• OSDP Secure Channel - Controller PUT no longer resets secure channel settings
• Shared Door Groups - Listing now includes groups shared via domain leases

Added​

Revisions API​

Three new endpoints for querying entity change history:

Filtering Options​

• entityType - Filter by entity type (DOOR, USER, CONTROLLER, etc.)
• entityId - Filter by entity ID
• type - Filter by revision type (CREATE, UPDATE, DELETE, RETIRE)
• mintime/maxtime - Filter by time range (epoch milliseconds)
• offset/limit - Pagination (default limit: 50, max: 1000)

Permission-Based Access​

Results are filtered based on user permissions:

• ACCESS capacity: doors, users, controllers, devices, schedules, privileges, roles, hubs, doorgroups, triggers, commands, recipients, visits, permits, registrations
• PACS capacity: pacs, administrators, domains, leases, cardhandles
• ACCOUNT capacity: accounts

Tracked Entity Types​

DOOR, USER, CONTROLLER, DEVICE, SCHEDULE, PRIVILEGE, ROLE, HUB, PACS, ACCOUNT, ADMINISTRATOR, DOORGROUP, TRIGGER, COMMAND, RECIPIENT, DOMAIN, LEASE, VISIT, PERMIT, CARDHANDLE, REGISTRATION

Notes​

• Revision tracking availability depends on when the feature was deployed
• Historical entities may not have CREATE records
• Use the summary endpoint for quick creation/last-modified lookups

Documentation​

See Revisions API Reference for full details.

Added​

OSDP Secure Channel Workflows​

The system now supports OSDP (Open Supervised Device Protocol) Secure Channel workflows, enabling encrypted communication between controllers and readers. This enhancement:

• Provides end-to-end encryption for access control communications
• Ensures tamper-proof data transmission between devices
• Implements industry-standard secure channel establishment
• Adds new event types for secure channel status tracking (connection established, connection lost)

Related documentation: See the Events API reference for new secure channel event types and the method field usage.

Multiple Mobile App Enrollments​

The Remote API now supports enrolling mobile apps to multiple systems and accounts simultaneously, enabling:

• Cross-system mobile credential management
• Streamlined multi-tenant mobile access provisioning
• Simplified credential lifecycle management across organizational boundaries

Changed​

Safer Event Propagation​

Event handling has been refactored to use asynchronous processing with improved error handling:

• Events are now propagated asynchronously to prevent blocking operations
• Better isolation between event processing and core system operations
• Reduced risk of event processing failures affecting system stability
• Enhanced performance for high-volume event scenarios

HTTP Validation for Outgoing Webhooks​

Outgoing webhook configurations now include HTTP validation:

• URL format validation before webhook registration
• Protocol enforcement (HTTPS recommended)
• Prevents misconfigured webhooks from causing runtime errors

Schedule Change Tracking​

When schedules are modified, the system now correctly sets the event method field to "Administrator" for improved audit trails and clearer attribution of configuration changes.

Enhanced Request Tracking​

Improved X-Request-ID propagation throughout the system:

• Better correlation of requests across service boundaries
• Enhanced debugging capabilities for distributed operations
• Clearer audit trails in log aggregation systems

Fixed​

Database Connection Leak Detection​

Improved detection and prevention of database connection leaks:

• Enhanced monitoring of connection pool usage
• Better diagnostics for connection lifecycle issues
• Proactive warnings for potential resource exhaustion

OTP in Self-Service Password Change​

Resolved an issue where One-Time Password (OTP) verification was not working correctly during self-service password change flows.

Chrome List Panel Behavior​

Fixed a UI issue where list panel items did not behave properly in Chrome browser, particularly when only one element was present in the list.

Migration Notes​

For OSDP Secure Channel Users​

If you are using OSDP-compatible readers:

1. Ensure your readers support OSDP Secure Channel (SC) mode
2. Configure secure channel settings in your controller configuration
3. Monitor new secure channel event types in your event processing workflows
4. Update any event filtering logic to account for new secure channel status events

For Webhook Users​

Existing webhook configurations will continue to work, but we recommend:

1. Reviewing webhook URLs for HTTPS usage
2. Testing webhook endpoints after upgrade
3. Ensuring webhook URLs are properly formatted and accessible

API Version​

This release maintains API version v2 with full backwards compatibility. No client changes are required.

What's Next​

• Enhanced OSDP secure channel diagnostics and monitoring
• Extended mobile credential management capabilities
• Performance optimizations for large-scale event processing

SpringDoc enrichment​

• Added @Operation and standardized @CommonApiResponses across controllers
• Applied @Tag descriptions to collection-level resources (e.g., Doors), not per-id endpoints
• Generated a richer OpenAPI spec for interactive exploration

Apiary-faithful migration​

• Admin, Owner, Shortcuts, and Webhooks docs migrated to Docusaurus
• Preserved structure, examples, and terminology
• Centralized error handling and authentication according to Apiary

Error model alignment​

• Reiterated 200 (success) / 400 (error) pattern
• Documented {type, issue, info} error payload and common error types

Upcoming OAuth2/OIDC​

• New page added with upcoming OAuth2/OIDC details
• Basic Auth remains current method for v2

What’s next​

• Continue refining endpoint details in OpenAPI
• Add more examples and troubleshooting entries
• Announce docs/OpenAPI versions with semantic versioning in future posts

Current docs/OpenAPI version​

• Docs/OpenAPI version: 2.6.0 (initial semver tracking)
• API version: v2 (stable)

Why this change​

• Provide a clear history of docs/OpenAPI updates
• Explain rationale behind changes
• Offer migration tips and timelines

Versioning policy​

The documentation site and OpenAPI spec will follow Semantic Versioning (MAJOR.MINOR.PATCH):

• MAJOR: Incompatible changes that require client updates
• MINOR: Backwards-compatible additions
• PATCH: Backwards-compatible fixes

The API itself remains at v2 and follows the 200/400 error model.

Staying up to date​

• Subscribe to the blog RSS feed
• Check the new Versioning guide

First release notes post will follow shortly.