Waveshare

Not affiliated with Waveshare

OpenApp is an independent product and is not associated with, endorsed by, sponsored by, or affiliated with Waveshare in any way. "Waveshare" is a trademark of its respective owner and is used here only to describe interoperability.

For any issues with this integration, contact OpenApp — not Waveshare. Waveshare cannot support problems caused by OpenApp, and contacting them about this integration may delay a resolution.

Not for electrically locking a means of egress.OpenApp is ingress-only software. Occupants must be able to exit without this integration, the cloud, or a phone. SeeLife safety and egress.

At a glance

• Product: Waveshare
• Manufacturer: Waveshare

Getting started

This provider type supports controlling relay channels via Switchable actions by publishing Modbus RTU binary frames over MQTT.

Provisioning (VirCom + mqtt.txt)

OpenApp can provision supported Waveshare/ZLAN relay boards by speaking the vendor ZLAN UDP management protocol (the same protocol used by the VirCom tool).

• VirCom download: VirCom_en.rar (Waveshare)

Hardware device ID (required)

Each OpenApp Waveshare device requires a hardware device ID (hw_device_id). This is a stable, IP-independent identifier read from the board’s ZLAN status. OpenApp derives MQTT client ID and topics from it.

To obtain the HW device ID for your board:

1. From the dashboard: Open the device page and use Fetch HW device ID. This sends a ZLAN query to the board (requires the board to be reachable from the backend).
2. From VirCom: Open the VirCom Device Management UI and connect to your board. In the Device Info section (top left of the device settings dialog), find the Dev ID field. Copy that value (e.g. 2880F28D589E or F28D589E) into the device’s HW device ID field in OpenApp.

Steps

In the current model:

• Broker host/port are not stored on the integration. The API uses OPENAPP_MQTT_API_BROKER_* for relay commands; ZLAN provisioning uses OPENAPP_MQTT_DEVICE_BROKER_* for the address written to the board. The integration may store optional MQTT username/password when the broker requires them.
• Each device holds board-specific identity: board host/IP and hardware device ID (required). MQTT client ID and topics are derived from the HW device ID.
• The 30 relays are modeled as switch entities under the device, with metadata.channel_index (0..29).

Manual fallback (VirCom)

If the device is not reachable from OpenApp (or UDP management is blocked), you can provision manually:

1. Obtain the HW device ID from VirCom (see Dev ID in the Device Info section of the device settings dialog).
2. Generate a mqtt.txt payload (VirCom format) containing per-device topics and credentials.
3. In VirCom, configure the MQTT server IP/port and upload/flash mqtt.txt to the device.

Note: OpenApp cannot perform the manual VirCom step for you; it requires the vendor UI.

Setup reference

Field	Type	Required	Description	Default	Example
OPENAPP_MQTT_API_BROKER_HOST / OPENAPP_MQTT_API_BROKER_PORT	string	required	Required deployment environment variables: hostname and port the **OpenApp API** uses to publish Modbus-over-MQTT. No defaults — the process fails fast if unset.	—	your-broker.internal
OPENAPP_MQTT_DEVICE_BROKER_HOST / OPENAPP_MQTT_DEVICE_BROKER_PORT	string	required	Required deployment environment: broker address **programmed onto boards** via ZLAN provisioning (often a LAN IP reachable from devices). Local compose uses **1883**; deployed zones use **8883**. No defaults.	—	mqtt.openapp.house:8883
mqtt_username	string	optional	Per-integration MQTT principal (`ws:{integration_id}`), issued on provisioning status and written to the board. Not a shared broker password.	—	ws:01ARZ3NDEKTSV4RRFFQ69G5FAV
mqtt_password	string	optional	Password for the per-integration principal above (issued by OpenApp, not a shared env secret).	—	********

Secrets

Waveshare does not use integration secrets.

Troubleshooting: relay toggle does nothing

Relay commands are MQTT publishes from the API to the board’s subscribe topic. The board must be connected to the broker using OPENAPP_MQTT_DEVICE_BROKER_* (ZLAN programs that address). It must be an IP/hostname the board can route to on the LAN. Local compose publishes authenticated MQTT on 1883; deployed zones expose MQTTS on 8883. Do not point the board at an address only reachable from inside a container network.

API traffic uses OPENAPP_MQTT_API_BROKER_*. Device programming uses OPENAPP_MQTT_DEVICE_BROKER_*.

Verify: EMQX Dashboard → Clients (board should appear), or subscribe with an MQTT client to the Modbus topic while toggling.

Policies

Policies restrict access on top of roles — they never grant it. Browse the policy catalog for arguments and examples. Expand a category below to see the policies that apply to this integration, then expand a policy for details.

Invitations

Guest invites — duration, uses, who may create them, and which doors they can cover.

19 policies

Invitation curfew

Blocks invitation-based opens during a forbidden time window (for example nights).

Admins and residents are never curfewed; existing invitations are evaluated live, not modified.

Learn more — Invitation curfew

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no hour restrictions on invitation-based access.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max invitation duration

Caps how long each invitation schedule slot may last.

Longer create or update requests are rejected, not shortened.

Learn more — Max invitation duration

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no policy cap on invitation slot length.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max share duration

Caps how long a short-term share (TTL invitation) may last.

Combined with max invitation duration as the stricter of the two. Longer create requests are rejected, not shortened.

Learn more — Max share duration

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

System default is 86400 (1 day) when unset. Org policy may raise the share cap up to 31536000 (365d).

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Default share uses

When the author omits a use count on a share, store this default.

The system default is 1 when this policy is not configured.

Learn more — Default share uses

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — omitted share max_uses stores 1.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max share uses

Ceiling on how many times a share may be used.

Unlimited shares require allow_unlimited on every applicable row and no invitation_max_uses.

Learn more — Max share uses

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no extra ceiling; unlimited shares remain forbidden.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max invitation uses

Requires a finite use count and rejects unlimited invitations or counts above the cap.

Learn more — Max invitation uses

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — unlimited-use invitations are allowed.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max invitation devices

Caps the number of unique guest browsers or app installations that may register an invitation.

Learn more — Max invitation devices

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — invitations may register any number of devices.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max active invitations per user

Caps how many enabled, unexpired invitations one person may have at once.

Learn more — Max active invitations per user

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no cap on how many invitations one person may keep active.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Require invitation expiry

Forbids open-ended recurring invitations that never end.

Learn more — Require invitation expiry

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — never-ending recurring invitations are allowed.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Allowed entry kinds

Limits which portal types (door, gate, boom-gate) an invitation may grant.

Combination intersects allowed sets.

Learn more — Allowed entry kinds

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — any portal entry kind may be granted.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Require invitation justification

Requires a non-empty creation justification when creating or updating an invitation.

Learn more — Require invitation justification

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — justification is optional.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max doors per invitation

Caps how many unique portals a single invitation may grant.

Learn more — Max doors per invitation

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no policy cap on portals per invitation.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Own-apartment doors only

Invitations may only grant doors the author can open as a resident of an allowed apartment.

Org/integration admins are exempt unless applies_to says otherwise. PalGate-only sites with no apartments fail for residents.

Learn more — Own-apartment doors only

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — invitations may grant any portal the author can otherwise share.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Prohibit master-door invitations

Rejects an invitation if any granted portal’s door is a listed OpenApp device id (union of ids; never client-forged hardware ids).

Learn more — Prohibit master-door invitations

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — master doors may be granted on invitations.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Who may invite

Literal allow-list of roles that may create invitations.

Combination intersects lists; empty intersection means nobody. Not admin-exempt. Compose with user_sharing (both must pass).

Learn more — Who may invite

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — anyone who can otherwise create invitations may do so.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

No invitation re-share

When the row binds the actor, invite create/update is rejected.

Org/integration default bind is resident (invitees), not generic members. Device-tier without applies_to binds everyone.

Learn more — No invitation re-share

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — invitees may create further invitations if their roles allow it.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Require invitation identity

Requires a host PIN, a host-attached photo, and/or a verified invitee phone before an invitation can be created or used.

Learn more — Require invitation identity

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — PIN, photo, and verified phone are optional.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

EnforceRequire approval

Invitation allowed days

Limits invitation-based opens to listed weekdays, minus blackout dates and optional holiday-calendar dates.

Existing invitations are evaluated live, not modified.

Learn more — Invitation allowed days

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — invitation-based access is not limited by weekday or blackout date.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Holiday calendar

Lists organization-local ISO dates that invitation allowed-days can treat as holidays.

This type does not deny access by itself.

Learn more — Holiday calendar

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no shared holiday date list.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Holds

Door hold-open and hold-closed — who may set a hold and for how long.

5 policies

Require hold expiry

Members and residents cannot set a permanent hold.

Temporary (and unless also forbidden, weekly) holds are still allowed.

Learn more — Require hold expiry

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — permanent holds are allowed for anyone with the set-hold role.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Max hold duration

Caps how long a temporary hold can last.

Longer requests are rejected, not shortened. PalGate hardware latch max is an extra cap when present.

Learn more — Max hold duration

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no policy cap on temporary hold duration.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

No repeating holds

Members and residents may only set a one-shot hold, not a repeating calendar schedule.

Learn more — No repeating holds

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — repeating holds are allowed for anyone with set-hold.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Allowed hold modes

Limits members and residents to hold-open, hold-closed, or both (for example, stay-off for lights but not stay-on).

Learn more — Allowed hold modes

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — both hold-open and hold-closed are allowed.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

No holds

Members and residents cannot set a hold, even if an admin granted the set-hold role.

Device-tier without applies_to binds everyone, including admins.

Learn more — No holds

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — anyone with the set-hold role may set a hold.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Sharing

Who may share access or manage linked users outside invitations.

3 policies

User sharing control

Restricts whether non-admins may share access or create invitations out of band — block outright or require admin approval.

Learn more — User sharing control

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — non-admins may share access freely.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

EnforceRequire approval

No transitive delegation

Invite create: org admin or apartment admin only.

Vendor users_admin writes (except list): org admin only. Runs in addition to user_sharing.

Learn more — No transitive delegation

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — ordinary role and user_sharing rules apply.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Approval threshold

Requires N distinct organization-admin approve votes before a pending policy approval proceeds.

Any deny denies. Self-approval does not count.

Learn more — Approval threshold

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — a single admin approve or deny is enough.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Lifecycle

Move-out and idle membership — revoke leftover invites without deleting the user.

2 policies

Revoke invites on move-out

When a resident is removed from an apartment, enabled invitations they authored that grant that apartment’s doors are revoked.

Learn more — Revoke invites on move-out

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — leftover invitations stay enabled after move-out.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Expire dormant users

After idle days, revoke that person’s invitations and remove residencies.

The user account is not deleted. Admins are exempt unless included.

Learn more — Expire dormant users

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — idle members and residents are not auto-expired.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Agent safety

Time windows, throttles, and extra confirmation for agents, API keys, and guests.

4 policies

Quiet hours

Blocks access during a local hour window for listed principal kinds (agents, API keys, invitations).

Admins are not restricted unless included.

Learn more — Quiet hours

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no quiet-hours window.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Rate limit

Throttles entity opens per principal in a sliding window so retrying agents cannot exhaust door quota.

Learn more — Rate limit

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no policy throttle on opens.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Require step-up

Requires extra confirmation before a physical write for the listed principal kinds.

Learn more — Require step-up

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no extra confirmation beyond ordinary authorization.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Anti-tailgating cooldown

After a successful open of an entity, further opens of that entity are denied until the cooldown elapses.

Admins are exempt by default.

Learn more — Anti-tailgating cooldown

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no per-door cooldown after a successful open.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Operational

Site-wide lockdown and notifications when a policy denies access.

6 policies

Emergency lockdown

When active, denies non-admin inbound cloud opens.

Does not lock a means of egress or fire-door assembly, and is not a building lock-in.

Learn more — Emergency lockdown

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

Org

DefaultWhat happens when no row of this type is configured.

Not configured — no lockdown.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Emergency free egress

When active, OpenApp will not deny inbound cloud opens.

This is not fire-alarm release.

Learn more — Emergency free egress

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

Org

DefaultWhat happens when no row of this type is configured.

Not configured — ordinary denies still apply.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Notify on curfew attempt

Emits an audit event (and configured channels) when curfew blocks an open.

Learn more — Notify on curfew attempt

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Denial hook

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — curfew denials are not additionally notified.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Maintenance window

During a local hour window, only listed roles may open.

Empty role intersection means nobody. Technicians match the same way as who-may-invite.

Learn more — Maintenance window

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — no technician-only maintenance window.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Notify on first use

Emits an audit event when an invitation’s use count goes from 0 to 1, if audit is among the channels.

Learn more — Notify on first use

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Access-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — first invitation use is not additionally notified.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce

Notify on new sharing

Emits an audit event after users_admin writes (except list) and after invitation create that actually shares, if audit is among the channels.

Learn more — Notify on new sharing

Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).

Authoring-time

TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.

OrgIntegration

DefaultWhat happens when no row of this type is configured.

Not configured — new sharing is not additionally notified.

EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.

Enforce