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 API HTTP operations grouped for agents, codegen, and integration bots.

Start here

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

Resources

Organizations Tenant boundaries and ownership of users, integrations, and resources.

Users User identities and membership in organizations.

Roles What a user is allowed to do inside an organization.

API keys Personal access tokens for programmatic API access.

Devices Physical or virtual devices owned by an integration.

Entities Controllable resources on devices — relays, lights, sensors, etc.

Zones Logical or physical spaces that contain entities.

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

Secrets storage How OpenApp stores integration secrets in AWS Secrets Manager.