Reference

This section is the canonical reference for OpenApp’s data model — the objects the API exposes, how they relate, and what fields they carry. If you want the HTTP-level contract (paths, schemas, status codes), see the API reference instead.

Solution architect? Start with architecture

If you are in design/evaluation mode (trade-offs across hardware, connectivity, and risk), begin with Choosing access control architecture and then use this reference for implementation details.

Agents & automation

Agent-relevant APIHTTP operations grouped for agents, codegen, and integration bots.

Start here

Resource hierarchyHow orgs, users, roles, integrations, devices, entities, and zones fit together.

Resources

OrganizationsTenant boundaries and ownership of users, integrations, and resources.

UsersUser identities and membership in organizations.

RolesWhat a user is allowed to do inside an organization.

Policy catalogAdministrative limits on top of roles — every shipped type, searchable.

API keysPersonal access tokens for programmatic API access.

DevicesPhysical or virtual devices owned by an integration.

EntitiesControllable resources on devices — relays, lights, sensors, etc.

ZonesLogical or physical spaces that contain entities.

OpenApp ScriptingRhai-based scripting (DSL) for provisioning and automating resources.

Secrets storageHow OpenApp stores integration secrets in AWS Secrets Manager.