Skip to main content

Org Templates

Org Templates enable rapid, consistent organization onboarding by pre-packaging configuration settings that can be applied when creating new organizations.

What is an Org Template?​

An Org Template is a pre-configured organization setup that standardizes and accelerates the creation of new organizations in Beacon Tower. Instead of manually configuring privileges, relations, themes, and notification contacts for each new organization, you can define these settings once in a template and apply them automatically during organization creation.

Each template consists of:

  • displayName — Human-readable template name (required)
  • description — Purpose and scope of the template (optional)
  • tags — Key-value pairs for filtering and categorization (optional)
  • document — JSON structure containing the template configuration (required)
  • organizationId — The organization that owns this template (required)
  • metadata — Additional system-managed information (optional)
  • history — Template version history (optional, system-managed)

Template Contents​

The document field contains the configuration that will be applied to new organizations:

Privileges​

Defines which management privileges the new organization will receive. Privileges control access to features like asset management, user administration, dashboard creation, and flow configuration.

Relations​

Pre-configured access to platform resources:

  • Dashboards — Default dashboards available to the organization
  • Models — Asset models the organization can use
  • Alarms — Pre-configured alarm definitions
  • Notifications — Default notification channels and rules

Theme​

Default visual theme settings for the organization, including color schemes, logos, and branding elements. See Themes for more details.

Contacts​

Default notification recipients for system alerts, alarms, and operational messages. This ensures critical notifications reach the right people from day one.

Templates eliminate repetitive manual configuration, reduce onboarding errors, and ensure organizational consistency across similar deployment scenarios.

Creating a Template​

Templates are typically created after establishing a proven organization configuration that you want to replicate. The template captures the configuration from an existing organization or defines it from scratch.

API Method​

Use POST /orgTemplates to create a new template:

curl -X POST https://api.beacontower.ai/orgTemplates \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Standard Manufacturing Org",
    "description": "Default template for manufacturing facility organizations with basic monitoring and alerting",
    "tags": {
      "industry": "manufacturing",
      "tier": "standard",
      "region": "north-america"
    },
    "document": {
      "privileges": [
        "asset.read",
        "asset.write",
        "dashboard.read",
        "flow.read",
        "alarm.read"
      ],
      "relations": {
        "dashboards": ["default-manufacturing-dashboard"],
        "models": ["temperature-sensor", "pressure-sensor"],
        "notifications": ["ops-team-channel"]
      },
      "theme": {
        "primaryColor": "#1976d2",
        "logo": "https://cdn.example.com/mfg-logo.png"
      },
      "contacts": [
        {
          "type": "email",
          "address": "ops@example.com"
        }
      ]
    },
    "organizationId": "org_abc123"
  }'

Tag Filtering​

Tags support advanced filtering with AND (&) and OR (|) operators, just like resource tagging:

  • industry=manufacturing&tier=standard — Both conditions must match
  • region=north-america|region=europe — Either condition matches

Applying a Template​

When creating a new organization, you can optionally specify a template ID. Beacon Tower automatically applies all template settings during organization creation:

  1. Privileges are granted to the new organization
  2. Relations to dashboards, models, and other resources are established
  3. Theme settings are applied
  4. Default notification contacts are configured

After template application, you can further customize the organization to meet specific requirements.

curl -X POST https://api.beacontower.ai/organizations \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Acme Manufacturing - Plant 3",
    "templateId": "tmpl_mfg_standard_001"
  }'

Managing Templates​

List Templates​

Retrieve all templates accessible to your organization. Supports tag filtering:

# List all templates
curl -X GET https://api.beacontower.ai/orgTemplates \
  -H "X-API-Key: YOUR_API_KEY"

# Filter by tags
curl -X GET "https://api.beacontower.ai/orgTemplates?tags=industry=manufacturing&tier=standard" \
  -H "X-API-Key: YOUR_API_KEY"

Get Template Details​

Retrieve a specific template by ID:

curl -X GET https://api.beacontower.ai/orgTemplates/tmpl_mfg_standard_001 \
  -H "X-API-Key: YOUR_API_KEY"

Update Template​

Modify an existing template's display name, description, tags, or document:

curl -X PATCH https://api.beacontower.ai/orgTemplates/tmpl_mfg_standard_001 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated template with enhanced monitoring capabilities",
    "document": {
      "privileges": [
        "asset.read",
        "asset.write",
        "dashboard.read",
        "dashboard.write",
        "flow.read",
        "alarm.read"
      ]
    }
  }'

Delete Template​

Remove a template that is no longer needed:

curl -X DELETE https://api.beacontower.ai/orgTemplates/tmpl_mfg_standard_001 \
  -H "X-API-Key: YOUR_API_KEY"

Deleting a template does not affect organizations that were created using that template. They retain their applied configuration.

Use Cases​

Org Templates are particularly valuable for:

  • Multi-tenant SaaS platforms — Standardize customer onboarding with predefined privilege and access patterns
  • Franchise or branch operations — Ensure consistent configuration across multiple locations
  • Tiered service offerings — Create templates for Basic, Professional, and Enterprise tiers
  • Industry-specific deployments — Package configurations tailored to manufacturing, logistics, energy, or other verticals
  • Development and testing — Quickly spin up test organizations with realistic configurations