> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Permissions Reference

> Reference for KODE OS role permissions by product

## Role Permissions

Each role in **KODE OS** defines access through per-product permissions. Permissions are classified as `Read` or `Write` and determine what actions a user can perform on a resource. Use the permissions reference below to understand what permissions are available across `KODE OS` products.

### AssetOps

Controls access to the AssetOps application for asset and maintenance operations.

<Expandable title="General">
  <ParamField path="Get AssetOps" type="Read">
    Access the AssetOps application.
  </ParamField>
</Expandable>

<Expandable title="Assets">
  <ParamField path="Get Assets" type="Read">
    View assets and their details.
  </ParamField>

  <ParamField path="Delete Asset" type="Write">
    Delete an asset.
  </ParamField>

  <ParamField path="Update Asset" type="Write">
    Modify an existing asset.
  </ParamField>
</Expandable>

<Expandable title="Categories">
  <ParamField path="Get Categories" type="Read">
    View asset categories.
  </ParamField>

  <ParamField path="Create Category" type="Write">
    Create a new asset category.
  </ParamField>

  <ParamField path="Delete Category" type="Write">
    Delete an asset category.
  </ParamField>

  <ParamField path="Update Category In Site" type="Write">
    Update a category at the site level.
  </ParamField>

  <ParamField path="Update Category" type="Write">
    Modify an existing category.
  </ParamField>
</Expandable>

<Expandable title="Closure Policies">
  <ParamField path="Get Closure Policies" type="Read">
    View closure policies configured for AssetOps.
  </ParamField>

  <ParamField path="Update Site Closure Policies" type="Write">
    Update closure policies at the site level.
  </ParamField>

  <ParamField path="Update Closure Policies" type="Write">
    Modify existing closure policies.
  </ParamField>
</Expandable>

<Expandable title="Dashboard">
  <ParamField path="Get site Dashboard" type="Read">
    View the AssetOps dashboard for a specific site.
  </ParamField>

  <ParamField path="Get Portfolio Dashboard" type="Read">
    View the AssetOps dashboard at the portfolio level.
  </ParamField>
</Expandable>

<Expandable title="Data Sources">
  <ParamField path="Get Data Sources" type="Read">
    View data sources connected to AssetOps.
  </ParamField>

  <ParamField path="Create Data Source" type="Write">
    Add a new data source.
  </ParamField>

  <ParamField path="Delete Data Source" type="Write">
    Remove a data source.
  </ParamField>
</Expandable>

<Expandable title="Discovery Configurations">
  <ParamField path="Get Discovery Configurations" type="Read">
    View asset discovery configurations.
  </ParamField>

  <ParamField path="Update Discovery Configurations" type="Write">
    Modify asset discovery configurations.
  </ParamField>
</Expandable>

<Expandable title="Discovery Logs">
  <ParamField path="Get Discovery Logs" type="Read">
    View logs from asset discovery runs.
  </ParamField>

  <ParamField path="Initiate Discovery" type="Write">
    Manually trigger an asset discovery run.
  </ParamField>
</Expandable>

<Expandable title="Discrepancy Reports">
  <ParamField path="Get Discrepancy Reports" type="Read">
    View discrepancy reports generated by AssetOps.
  </ParamField>

  <ParamField path="Create Discrepancy Report" type="Write">
    Generate a new discrepancy report.
  </ParamField>
</Expandable>

<Expandable title="Notification Policies">
  <ParamField path="Get Notification Policies" type="Read">
    View notification policies configured for AssetOps.
  </ParamField>

  <ParamField path="Update Notification Policy" type="Write">
    Modify existing notification policies.
  </ParamField>
</Expandable>

<Expandable title="Schedules">
  <ParamField path="Get Schedules" type="Read">
    View maintenance schedules in AssetOps.
  </ParamField>

  <ParamField path="Create Schedule" type="Write">
    Create a new maintenance schedule.
  </ParamField>

  <ParamField path="Delete Schedule" type="Write">
    Delete a maintenance schedule.
  </ParamField>

  <ParamField path="Run Schedule" type="Write">
    Manually trigger a maintenance schedule.
  </ParamField>
</Expandable>

<Expandable title="Task Templates">
  <ParamField path="Get Task Templates" type="Read">
    View predefined task templates used for maintenance work.
  </ParamField>

  <ParamField path="Create Task Template" type="Write">
    Create a new task template.
  </ParamField>

  <ParamField path="Delete Task Template" type="Write">
    Delete an existing task template.
  </ParamField>
</Expandable>

<Expandable title="Teams">
  <ParamField path="Get Teams" type="Read">
    View teams configured in AssetOps.
  </ParamField>

  <ParamField path="Create Team" type="Write">
    Create a new team.
  </ParamField>

  <ParamField path="Delete Team" type="Write">
    Delete a team.
  </ParamField>
</Expandable>

<Expandable title="Vendors">
  <ParamField path="Get Vendors" type="Read">
    View vendors configured in AssetOps.
  </ParamField>

  <ParamField path="Create Vendors" type="Write">
    Create new vendors.
  </ParamField>

  <ParamField path="Delete Vendors" type="Write">
    Delete vendors.
  </ParamField>
</Expandable>

<Expandable title="Work Orders">
  <ParamField path="Get Work Orders" type="Read">
    View work orders in AssetOps.
  </ParamField>

  <ParamField path="Create Work Order" type="Write">
    Create a new work order.
  </ParamField>

  <ParamField path="Delete Work Order" type="Write">
    Delete a work order.
  </ParamField>

  <ParamField path="Update Work Order" type="Write">
    Update an existing work order.
  </ParamField>

  <ParamField path="Update Task List" type="Write">
    Update the task list associated with a work order.
  </ParamField>
</Expandable>

### Building BI

Controls access to the Building BI application for analytics dashboards and reporting.

<Expandable title="Dashboards">
  <ParamField path="Get Dashboards" type="Read">
    Retrieve and view all dashboards. Portfolio-level or building-level access control can restrict visibility.
  </ParamField>

  <ParamField path="Manage Collections" type="Write">
    Manage dashboard collections, including reordering, creating, editing, deleting, publishing, and managing viewers.
  </ParamField>

  <ParamField path="Create Dashboards" type="Write">
    Create new dashboards within Building BI.
  </ParamField>
</Expandable>

<Expandable title="Datasources">
  <ParamField path="Get Datasources" type="Read">
    View all data sources (both physical and virtual) within Building BI.
  </ParamField>

  <ParamField path="Create physical datasources" type="Write">
    Add physical data sources.
  </ParamField>

  <ParamField path="Create virtual datasources" type="Write">
    Create virtual data sources by writing queries on top of existing data sources.
  </ParamField>

  <ParamField path="Delete datasources" type="Write">
    Delete both physical and virtual data sources.
  </ParamField>
</Expandable>

<Expandable title="Deployment Manager">
  <ParamField path="Get Deployments" type="Read">
    View dashboard deployment configurations and status.
  </ParamField>

  <ParamField path="Create Dashboard Bulk Deployments" type="Write">
    Create bulk deployments of dashboards across buildings or portfolios.
  </ParamField>
</Expandable>

<Expandable title="Schedules">
  <ParamField path="Schedule PDF Reports" type="Read">
    View and access scheduled PDF report configurations.
  </ParamField>
</Expandable>

<Expandable title="Sharings">
  <ParamField path="Share Links" type="Read">
    Generate public, shareable links to dashboards or widgets for external users.
  </ParamField>
</Expandable>

<Expandable title="Templates">
  <ParamField path="Get Templates" type="Read">
    View and select from all available dashboard templates.
  </ParamField>

  <ParamField path="Create templates" type="Write">
    Save dashboards or views as templates for reuse.
  </ParamField>

  <ParamField path="Delete templates" type="Write">
    Delete existing templates.
  </ParamField>
</Expandable>

### BuildingDataHub

Controls access to the Building Data Hub for data pipelines and scheduled jobs.

<Expandable title="Pipelines">
  <ParamField path="Get Pipelines" type="Read">
    View data pipelines configured in the Building Data Hub.
  </ParamField>

  <ParamField path="Create Pipelines" type="Write">
    Create new data pipelines.
  </ParamField>
</Expandable>

<Expandable title="Schedule">
  <ParamField path="Get Schedules" type="Read">
    View scheduled jobs for data pipeline execution.
  </ParamField>

  <ParamField path="Create Schedules" type="Write">
    Create new scheduled jobs for data pipelines.
  </ParamField>
</Expandable>

### EnerG

Controls access to energy monitoring, reporting, and analytics across buildings and portfolios.

<Expandable title="General">
  <ParamField path="Get EnerG" type="Read">
    Access the EnerG application.
  </ParamField>

  <ParamField path="View Energy Hub" type="Read">
    Access the Energy Hub module for centralized energy analytics across buildings.
  </ParamField>

  <ParamField path="Edit Energy Hub" type="Write">
    Configure, customize, or update data sources, settings, and key performance indicators in the Energy Hub.
  </ParamField>
</Expandable>

<Expandable title="Alert Center">
  <ParamField path="Get Alert Center" type="Read">
    View configurations and active notifications for this module.
  </ParamField>

  <ParamField path="Edit Alert Center Configurations" type="Write">
    Modify settings and rules for this module.
  </ParamField>

  <ParamField path="Enable Alert Center Module" type="Write">
    Enable or disable this module.
  </ParamField>

  <ParamField path="Take Actions On Alerts" type="Write">
    Acknowledge, resolve, or perform other actions on notifications.
  </ParamField>
</Expandable>

<Expandable title="Baseline Configuration">
  <ParamField path="Get Baseline Configuration" type="Read">
    View baseline configurations used for energy comparison.
  </ParamField>

  <ParamField path="Create Baseline Configuration" type="Write">
    Create new baseline configurations.
  </ParamField>
</Expandable>

<Expandable title="Benchmarking">
  <ParamField path="Get Benchmarking" type="Read">
    View benchmarking data and comparisons.
  </ParamField>
</Expandable>

<Expandable title="Budget">
  <ParamField path="Get Budget" type="Read">
    View budget configurations and energy budget data.
  </ParamField>

  <ParamField path="Create Building Budget" type="Write">
    Create a budget for a building.
  </ParamField>

  <ParamField path="Delete Building Budget" type="Write">
    Delete a building budget.
  </ParamField>
</Expandable>

<Expandable title="Building Dashboards">
  <ParamField path="Get Building Budget Dashboard" type="Read">
    View the building budget dashboard.
  </ParamField>

  <ParamField path="Get Building Comparison Dashboard" type="Read">
    View the building comparison dashboard.
  </ParamField>

  <ParamField path="Get Building Cost Dashboard" type="Read">
    View the building cost dashboard.
  </ParamField>

  <ParamField path="Get Building Data Quality Dashboard" type="Read">
    View data quality metrics for building energy data.
  </ParamField>

  <ParamField path="Get Building Data Table" type="Read">
    View building energy data in table format.
  </ParamField>

  <ParamField path="Get Building Emissions Dashboard" type="Read">
    View carbon emissions and sustainability metrics for a building.
  </ParamField>

  <ParamField path="Get Building Interval Trends Dashboard" type="Read">
    View interval-level energy trends for a building.
  </ParamField>

  <ParamField path="Get Building Target Dashboard" type="Read">
    View building target and goal tracking.
  </ParamField>

  <ParamField path="Get Building Usage Dashboard" type="Read">
    View building energy usage dashboard.
  </ParamField>

  <ParamField path="Get Building Weather Normalization Dashboard" type="Read">
    View weather-normalized energy metrics for a building.
  </ParamField>

  <ParamField path="Create Export Template Building Data Table" type="Write">
    Create an export template for building data table exports.
  </ParamField>

  <ParamField path="Delete Export Template Building Data Table" type="Write">
    Delete an export template for building data tables.
  </ParamField>

  <ParamField path="Export Building Data Table" type="Write">
    Export building energy data to a file.
  </ParamField>
</Expandable>

<Expandable title="Building Information">
  <ParamField path="Get Building Information" type="Read">
    View building information configured in EnerG.
  </ParamField>

  <ParamField path="Edit Building Information" type="Write">
    Edit building information in EnerG.
  </ParamField>
</Expandable>

<Expandable title="Capital Plans">
  <ParamField path="Get Capital Planning" type="Read">
    View capital planning data and configurations.
  </ParamField>

  <ParamField path="Create Capital Planning" type="Write">
    Create capital planning entries.
  </ParamField>

  <ParamField path="Delete Capital Planning" type="Write">
    Delete capital planning entries.
  </ParamField>
</Expandable>

<Expandable title="Certifications">
  <ParamField path="Get Certifications" type="Read">
    View sustainability and energy certifications.
  </ParamField>

  <ParamField path="Create Certifications" type="Write">
    Create or register certifications.
  </ParamField>
</Expandable>

<Expandable title="Data Sources">
  <ParamField path="Get Accounts" type="Read">
    View energy accounts.
  </ParamField>

  <ParamField path="Get Bills" type="Read">
    View bill data.
  </ParamField>

  <ParamField path="Get Buildings" type="Read">
    View buildings linked to EnerG data sources.
  </ParamField>

  <ParamField path="Get Credentials" type="Read">
    View credential metadata for data source connections.
  </ParamField>

  <ParamField path="Get Data Sources" type="Read">
    View configured energy data sources.
  </ParamField>

  <ParamField path="Get Meters" type="Read">
    View energy meter records associated with data sources.
  </ParamField>

  <ParamField path="Get Providers" type="Read">
    View energy data providers.
  </ParamField>

  <ParamField path="Get Statements" type="Read">
    View billing or usage statements.
  </ParamField>

  <ParamField path="Activate And Deactivate Accounts" type="Write">
    Activate or deactivate energy accounts.
  </ParamField>

  <ParamField path="Add Credentials" type="Write">
    Add credentials for data source connections.
  </ParamField>

  <ParamField path="Assign And Unassign Accounts" type="Write">
    Assign or remove account assignments to buildings or portfolios.
  </ParamField>

  <ParamField path="Assign And Unassign Meters" type="Write">
    Assign or remove meter assignments to buildings or data sources.
  </ParamField>

  <ParamField path="Create Account" type="Write">
    Create a new energy account.
  </ParamField>

  <ParamField path="Create Connect Url" type="Write">
    Create connection URLs for data source integration.
  </ParamField>

  <ParamField path="Create Data Sources" type="Write">
    Create new energy data sources.
  </ParamField>

  <ParamField path="Create Meter" type="Write">
    Create a new meter.
  </ParamField>

  <ParamField path="Delete Data Sources" type="Write">
    Delete energy data sources.
  </ParamField>

  <ParamField path="Link And Unlink Buildings" type="Write">
    Link or unlink buildings to data sources or accounts.
  </ParamField>

  <ParamField path="Upload Bills" type="Write">
    Upload bill documents or data.
  </ParamField>
</Expandable>

<Expandable title="Energy Modeling">
  <ParamField path="Get Energy Modeling" type="Read">
    View energy modeling configurations and results.
  </ParamField>

  <ParamField path="Create Energy Modeling" type="Write">
    Create energy models.
  </ParamField>

  <ParamField path="Delete Energy Modeling" type="Write">
    Delete energy modeling configurations.
  </ParamField>
</Expandable>

<Expandable title="Meters">
  <ParamField path="Get Link Meters" type="Read">
    View linked meter configurations.
  </ParamField>

  <ParamField path="Get Meter Completeness" type="Read">
    View meter data completeness metrics.
  </ParamField>

  <ParamField path="Get Meters" type="Read">
    View energy meter records and meter metadata.
  </ParamField>

  <ParamField path="Get Meters Comparison" type="Read">
    View meter comparison configurations.
  </ParamField>

  <ParamField path="Create Meters Comparison" type="Write">
    Create meter comparison configurations.
  </ParamField>

  <ParamField path="Delete Meters Comparison" type="Write">
    Delete meter comparison configurations.
  </ParamField>

  <ParamField path="Edit Link Meters" type="Write">
    Edit linked meter configurations.
  </ParamField>

  <ParamField path="Edit Meters" type="Write">
    Edit meter configurations.
  </ParamField>

  <ParamField path="Edit Virtual Meters" type="Write">
    Edit virtual meter definitions.
  </ParamField>
</Expandable>

<Expandable title="Meters Dashboards">
  <ParamField path="Get Meter Data Quality Dashboard" type="Read">
    View meter data quality dashboard.
  </ParamField>

  <ParamField path="Get Meter Data Table" type="Read">
    View meter data in table format.
  </ParamField>

  <ParamField path="Get Meter Interval Trends Dashboard" type="Read">
    View interval-level trends for metering devices.
  </ParamField>

  <ParamField path="Get Meter Completeness" type="Read">
    View meter completeness metrics in dashboard context.
  </ParamField>

  <ParamField path="Get Meter Usage Dashboard" type="Read">
    View meter usage dashboard.
  </ParamField>

  <ParamField path="Create Export Template Meter Data Table" type="Write">
    Create an export template for meter data table exports.
  </ParamField>

  <ParamField path="Delete Export Template Meter Data Table" type="Write">
    Delete an export template for meter data tables.
  </ParamField>

  <ParamField path="Export Meter Data Table" type="Write">
    Export meter data to a file.
  </ParamField>
</Expandable>

<Expandable title="Meters Data">
  <ParamField path="Get Meters Data" type="Read">
    View raw or aggregated meter data.
  </ParamField>

  <ParamField path="Edit Meters Data" type="Write">
    Edit or correct meter data.
  </ParamField>
</Expandable>

<Expandable title="Portfolio Dashboards">
  <ParamField path="Get Portfolio Cost Dashboard" type="Read">
    View portfolio-level cost dashboard.
  </ParamField>

  <ParamField path="Get Data Table" type="Read">
    View portfolio energy data table.
  </ParamField>

  <ParamField path="Get Portfolio Emissions Dashboard" type="Read">
    View portfolio emissions dashboard.
  </ParamField>

  <ParamField path="Get Portfolio Target Dashboard" type="Read">
    View portfolio target dashboard.
  </ParamField>

  <ParamField path="Get Portfolio Usage Dashboard" type="Read">
    View portfolio usage dashboard.
  </ParamField>

  <ParamField path="Get Portfolio Weather Normalization Dashboard" type="Read">
    View portfolio weather normalization dashboard.
  </ParamField>

  <ParamField path="Create Export Template Portfolio Data Table" type="Write">
    Create an export template for portfolio data table exports.
  </ParamField>

  <ParamField path="Delete Export Template Portfolio Data Table" type="Write">
    Delete an export template for portfolio data tables.
  </ParamField>

  <ParamField path="Export Portfolio Data Table" type="Write">
    Export portfolio energy data to a file.
  </ParamField>
</Expandable>

<Expandable title="Targets">
  <ParamField path="Get Targets" type="Read">
    View energy or sustainability targets.
  </ParamField>

  <ParamField path="Create Targets" type="Write">
    Create new targets.
  </ParamField>

  <ParamField path="Delete Targets" type="Write">
    Delete targets.
  </ParamField>
</Expandable>

### Buildings

Controls access to building-level data, devices, systems, and configuration.

<Expandable title="General">
  <ParamField path="Get buildings" type="Read">
    View the list of buildings assigned to the user when logging into KODE OS.
  </ParamField>

  <ParamField path="Manage attachments related to buildings" type="Write">
    View, upload, and delete documents or media files attached to buildings, systems, or devices.
  </ParamField>

  <ParamField path="Assign users to buildings" type="Write">
    Assign or revoke user access to specific buildings.
  </ParamField>
</Expandable>

<Expandable title="Areas">
  <ParamField path="Get areas" type="Read">
    View the Areas module in the side panel and list areas within a building.
  </ParamField>

  <ParamField path="Create areas" type="Write">
    Define and create new areas (zones, rooms, floors) within a building.
  </ParamField>

  <ParamField path="Create area dashboards" type="Write">
    Create dashboards specific to an area, available in the area detail page.
  </ParamField>

  <ParamField path="Delete areas" type="Write">
    Delete existing areas from the building layout.
  </ParamField>

  <ParamField path="Delete area dashboards" type="Write">
    Delete dashboards created within the context of an area.
  </ParamField>
</Expandable>

<Expandable title="Datasources">
  <ParamField path="Get datasources" type="Read">
    View the Data Sources module and all configured sources within a building.
  </ParamField>

  <ParamField path="Create datasources" type="Write">
    Create new data sources within the building context.
  </ParamField>

  <ParamField path="Delete datasources" type="Write">
    Delete existing data sources from a building.
  </ParamField>

  <ParamField path="Clear datasource cache" type="Write">
    Manually clear the cached data of data sources to refresh stale or outdated data.
  </ParamField>

  <ParamField path="Discover data source devices" type="Write">
    Run device discovery from a data source and import discovered devices, points, and schedules into KODE OS.
  </ParamField>

  <ParamField path="Discover datasource devices via sheet" type="Write">
    Import devices from a sheet-based source into the building.
  </ParamField>
</Expandable>

<Expandable title="Devices">
  <ParamField path="Get devices" type="Read">
    View the Devices module for a building and access all devices and their associated points.
  </ParamField>

  <ParamField path="Get device types" type="Read">
    View all available device types, including system-defined and custom types.
  </ParamField>

  <ParamField path="Get linked devices" type="Read">
    Retrieve the list of linked devices (device-to-device or device-to-system relationships).
  </ParamField>

  <ParamField path="Get device graphic templates" type="Read">
    View available device graphic templates for visual representation of devices.
  </ParamField>

  <ParamField path="Get building device graphics" type="Read">
    View the graphical representation of devices from the device details page.
  </ParamField>

  <ParamField path="Get Manual Meters" type="Read">
    View manually entered meter definitions in the building.
  </ParamField>

  <ParamField path="Get Manual Readings" type="Read">
    View manually entered meter readings.
  </ParamField>

  <ParamField path="Manage device types" type="Write">
    Create, modify, or delete custom device types used across the platform.
  </ParamField>

  <ParamField path="Manage device and system attachments" type="Write">
    Attach or detach devices to systems or locations within a building.
  </ParamField>

  <ParamField path="Update devices" type="Write">
    Modify device configurations, including metadata and mappings.
  </ParamField>

  <ParamField path="Delete devices" type="Write">
    Permanently delete devices from the building.
  </ParamField>

  <ParamField path="Manage linked devices" type="Write">
    Access and manage the Linked Devices module, including creating or removing device associations.
  </ParamField>

  <ParamField path="Manage virtual devices" type="Write">
    Create, update, or delete virtual devices (aggregated or logical devices built from multiple data points).
  </ParamField>

  <ParamField path="Manage device and point templating" type="Write">
    Configure device and point mappings to standardized ontology templates.
  </ParamField>

  <ParamField path="Manage AI-assisted templating" type="Write">
    Configure AI-assisted device and point templating.
  </ParamField>

  <ParamField path="Manage device metadata" type="Write">
    Edit device metadata and custom attributes.
  </ParamField>

  <ParamField path="Create Manual Meters" type="Write">
    Create manually entered meter definitions.
  </ParamField>

  <ParamField path="Update Manual Meters" type="Write">
    Update manually entered meter definitions.
  </ParamField>

  <ParamField path="Delete Manual Meters" type="Write">
    Delete manually entered meter definitions.
  </ParamField>

  <ParamField path="Write Manual Readings" type="Write">
    Enter or update manual meter readings.
  </ParamField>

  <ParamField path="Delete Manual Readings" type="Write">
    Delete manually entered meter readings.
  </ParamField>

  <ParamField path="Create device graphic templates" type="Write">
    Create new graphic templates for devices.
  </ParamField>

  <ParamField path="Update device graphics" type="Write">
    Modify device graphics in the graphics interface.
  </ParamField>

  <ParamField path="Delete device graphic templates" type="Write">
    Delete existing graphic templates.
  </ParamField>

  <ParamField path="Delete device graphics" type="Write">
    Delete individual graphics assigned to devices.
  </ParamField>
</Expandable>

<Expandable title="Points">
  <ParamField path="Get points" type="Read">
    Access the Points module and view all points (sensors, commands, statuses) associated with devices.
  </ParamField>

  <ParamField path="Get point units" type="Read">
    View the measurement units associated with points.
  </ParamField>

  <ParamField path="Update points" type="Write">
    Modify point configurations, such as renaming, reconfiguring units, or modifying descriptions.
  </ParamField>

  <ParamField path="Delete points" type="Write">
    Remove points from a device or system.
  </ParamField>

  <ParamField path="Write points" type="Write">
    Send commands or perform manual overrides on writable points (for example, temperature set points or mode changes).
  </ParamField>

  <ParamField path="Manage point units" type="Write">
    Create, edit, or delete custom point units used across devices.
  </ParamField>
</Expandable>

<Expandable title="Space Assignments">
  <ParamField path="Get space assignments" type="Read">
    View space assignment configurations linking spaces to users or other entities.
  </ParamField>

  <ParamField path="Create space assignment" type="Write">
    Create new space assignments.
  </ParamField>

  <ParamField path="Update space assignment" type="Write">
    Modify existing space assignments.
  </ParamField>

  <ParamField path="Delete space assignment" type="Write">
    Remove space assignments.
  </ParamField>
</Expandable>

<Expandable title="Areas (Spaces)">
  <ParamField path="Get areas" type="Read">
    View areas in the space context.
  </ParamField>

  <ParamField path="Create areas" type="Write">
    Create new areas in the space context.
  </ParamField>

  <ParamField path="Create space dashboards" type="Write">
    Create dashboards within a space.
  </ParamField>

  <ParamField path="Delete areas" type="Write">
    Delete areas in the space context.
  </ParamField>

  <ParamField path="Delete space areas" type="Write">
    Delete space-level areas.
  </ParamField>

  <ParamField path="Manage area attachments" type="Write">
    View, upload, or delete attachments on areas.
  </ParamField>

  <ParamField path="Update areas" type="Write">
    Modify existing areas in the space context.
  </ParamField>
</Expandable>

<Expandable title="Systems">
  <ParamField path="Get systems" type="Read">
    Access the Systems module and view mechanical, electrical, or logical systems in a building.
  </ParamField>

  <ParamField path="Create systems" type="Write">
    Define and create new systems within a building.
  </ParamField>

  <ParamField path="Delete systems" type="Write">
    Remove systems and their relationships from a building.
  </ParamField>
</Expandable>

<Expandable title="Tags">
  <ParamField path="Get tags" type="Read">
    View all existing tags in the Admin module.
  </ParamField>

  <ParamField path="Create tags" type="Write">
    Create new tags for classifying assets, devices, and other elements.
  </ParamField>

  <ParamField path="Delete tags" type="Write">
    Delete tags from the Admin module.
  </ParamField>
</Expandable>

<Expandable title="Miscellaneous">
  <ParamField path="Get notifications" type="Read">
    Retrieve and view system-generated notifications (alerts, updates, warnings) related to buildings.
  </ParamField>

  <ParamField path="Get geocode address" type="Read">
    Retrieve the geolocation and address of a building.
  </ParamField>

  <ParamField path="Get weather data" type="Read">
    Retrieve real-time weather data integrated with the building's location.
  </ParamField>
</Expandable>

<Expandable title="Dashboards">
  <ParamField path="Get dashboards" type="Read">
    View building-level dashboards.
  </ParamField>

  <ParamField path="Create dashboards" type="Write">
    Create building-level dashboards.
  </ParamField>

  <ParamField path="Delete dashboards" type="Write">
    Delete building-level dashboards.
  </ParamField>
</Expandable>

### Modules

Controls access to core KODE OS platform features such as FDD, FTT, graphics, schedules, trends, admin, and connectivity.

<Expandable title="Tenants">
  <ParamField path="Get tenants" type="Read">
    View tenants in the portfolio.
  </ParamField>

  <ParamField path="Get building tenants" type="Read">
    View tenants assigned to a building.
  </ParamField>

  <ParamField path="Assign buildings to tenant" type="Write">
    Assign buildings to a tenant.
  </ParamField>

  <ParamField path="Create tenant" type="Write">
    Create a new tenant.
  </ParamField>

  <ParamField path="Delete tenant" type="Write">
    Delete a tenant.
  </ParamField>

  <ParamField path="Update tenant" type="Write">
    Update tenant details.
  </ParamField>
</Expandable>

<Expandable title="Admin">
  <ParamField path="Access admin panel" type="Read">
    Access the Admin panel from the portfolio view.
  </ParamField>
</Expandable>

<Expandable title="FDDV2">
  <ParamField path="Get FDD events" type="Read">
    Track events and receive associated notifications for proactive operational awareness.
  </ParamField>

  <ParamField path="Get FDD routines" type="Read">
    View the list of custom routines used for equipment monitoring.
  </ParamField>

  <ParamField path="Get FDD configs" type="Read">
    View FDD system configurations, including which routines run for monitoring equipment.
  </ParamField>

  <ParamField path="Export FDD configs" type="Read">
    Export FDD configurations.
  </ParamField>

  <ParamField path="Get FDD notification policy" type="Read">
    View notification policies that define who receives notifications, message content, and delivery method.
  </ParamField>

  <ParamField path="Get FDD Event Routine View" type="Read">
    View the FDD event routine view.
  </ParamField>

  <ParamField path="Get Faults" type="Read">
    View fault records.
  </ParamField>

  <ParamField path="Get Faults Comments" type="Read">
    View comments on faults.
  </ParamField>

  <ParamField path="Get Faults Activity Logs" type="Read">
    View activity logs for faults.
  </ParamField>

  <ParamField path="Get Faults Triage Rules" type="Read">
    View fault triage rules.
  </ParamField>

  <ParamField path="Get WorkOrder List" type="Read">
    View the list of work orders linked to FDD events.
  </ParamField>

  <ParamField path="Notify users through phone call" type="Read">
    Initiate phone calls to notify users about important events.
  </ParamField>

  <ParamField path="Notify users through phone text message" type="Read">
    Send SMS alerts to designated recipients when specific events occur.
  </ParamField>

  <ParamField path="Acknowledge FDD events" type="Write">
    Mark an event as acknowledged to indicate a user has seen it and the appropriate process will follow.
  </ParamField>

  <ParamField path="Create FDD configs" type="Write">
    Configure FDD settings to define which equipment FDD monitors and establish notification thresholds.
  </ParamField>

  <ParamField path="Create FDD notification policy" type="Write">
    Create and modify building-level notification policies, including delivery method (email, push, SMS, or phone call).
  </ParamField>

  <ParamField path="Create FDD Portfolio notification policy" type="Write">
    Create and modify notification policies at the portfolio level for reuse across multiple buildings.
  </ParamField>

  <ParamField path="Create FDD routines" type="Write">
    Create custom routines using the logic block programming tool for automated building operations.
  </ParamField>

  <ParamField path="Delete FDD notification policy" type="Write">
    Delete notification policies at the building level.
  </ParamField>

  <ParamField path="Delete FDD Portfolio notification policy" type="Write">
    Delete notification policies applied at the portfolio level.
  </ParamField>

  <ParamField path="Delete FDD routines" type="Write">
    Remove custom-created FDD routines. Library routines aren't affected.
  </ParamField>

  <ParamField path="Import Export FDD routines" type="Write">
    Import and export routines between portfolios for managing custom libraries.
  </ParamField>

  <ParamField path="Manual Run Jobs" type="Write">
    Manually trigger FDD jobs.
  </ParamField>

  <ParamField path="Send or resend external-push" type="Write">
    Send or resend push notifications to third-party systems for integrating FDD events with work order platforms.
  </ParamField>

  <ParamField path="Update Faults Triage Rules" type="Write">
    Create or update fault triage rules.
  </ParamField>

  <ParamField path="Update faults metadata" type="Write">
    Update metadata on fault records.
  </ParamField>

  <ParamField path="Upsert FDD Ack Event Preferences" type="Write">
    Set the portfolio-level SLA response time for acknowledging events and comment requirements.
  </ParamField>

  <ParamField path="Upsert FDD Building Dashboard Filters Preferences" type="Write">
    Set default filters for other users on the building-level FDD dashboard.
  </ParamField>

  <ParamField path="Upsert FDD Portfolio Dashboard Filters Preferences" type="Write">
    Set default filters on the portfolio-level FDD dashboard for all users.
  </ParamField>

  <ParamField path="Upsert FDD Portfolio TableView Preferences" type="Write">
    Set portfolio-level table view preferences for the FDD dashboard.
  </ParamField>

  <ParamField path="Upsert/Hide priorities" type="Write">
    Customize the names and colors used to represent priorities within the portfolio.
  </ParamField>
</Expandable>

<Expandable title="FTT">
  <ParamField path="Get FTT workflows" type="Read">
    View the custom workflows used to perform functional tests on equipment.
  </ParamField>

  <ParamField path="Get FTT projects" type="Read">
    View all FTT projects created for the building or portfolio.
  </ParamField>

  <ParamField path="Get FTT history" type="Read">
    View test results and data from tests performed within the system.
  </ParamField>

  <ParamField path="Get FTT WorkOrder List" type="Read">
    View the list of work orders linked to FTT.
  </ParamField>

  <ParamField path="Create FTT workflows" type="Write">
    Create custom functional testing workflows using the logic block programming tool.
  </ParamField>

  <ParamField path="Delete FTT workflow" type="Write">
    Remove custom functional testing workflows. Library workflows aren't affected.
  </ParamField>

  <ParamField path="Create FTT Projects" type="Write">
    Schedule tests across multiple devices, floors, or an entire building.
  </ParamField>

  <ParamField path="Run/Stop tasks manually" type="Write">
    Control the manual start or stop of testing after you enable a scheduled project.
  </ParamField>

  <ParamField path="Run manual test" type="Write">
    Test the functionality of a specific device for targeted troubleshooting.
  </ParamField>

  <ParamField path="Archive FTT tests" type="Write">
    Mark a result as archived, commonly used during initial setup or when handling inconclusive results.
  </ParamField>

  <ParamField path="Update FTT concurrently running tests" type="Write">
    Set the number of devices tested concurrently within a single task (1 to 5, default is 3).
  </ParamField>

  <ParamField path="Import and Export FTT Workflows" type="Write">
    Import and export workflows to manage custom libraries across portfolios.
  </ParamField>

  <ParamField path="Send external push or resend an existing one" type="Write">
    Send or resend push notifications to third-party systems for FTT results.
  </ParamField>

  <ParamField path="Upsert FTT Building Dashboard Filters Preferences" type="Write">
    Set default filters for other users on the building-level FTT dashboard.
  </ParamField>

  <ParamField path="Upsert FTT Portfolio Dashboard Filters Preferences" type="Write">
    Set default filters on the portfolio-level FTT dashboard for all users.
  </ParamField>
</Expandable>

<Expandable title="GraphicsV1">
  <ParamField path="Get Old Graphics (V1)" type="Read">
    View legacy (V1) graphics in system and device details.
  </ParamField>
</Expandable>

<Expandable title="GraphicsV2">
  <ParamField path="Get Graphics" type="Read">
    View graphics in system and device details.
  </ParamField>

  <ParamField path="Get Area Graphics" type="Read">
    View graphics associated with areas.
  </ParamField>

  <ParamField path="Get Device Graphics" type="Read">
    View graphics associated with devices.
  </ParamField>

  <ParamField path="Get System Graphics" type="Read">
    View graphics associated with systems.
  </ParamField>

  <ParamField path="Edit Graphics" type="Write">
    Access the Graphics module from the main left menu and modify floor plans, system, and device graphics.
  </ParamField>

  <ParamField path="Share Dashboards" type="Write">
    Share dashboard views from the graphics context.
  </ParamField>
</Expandable>

<Expandable title="SchedulesV2">
  <ParamField path="Get schedules" type="Read">
    View the Schedules module and schedule details of a building.
  </ParamField>

  <ParamField path="Create schedules" type="Write">
    Create new schedules.
  </ParamField>

  <ParamField path="Update schedules" type="Write">
    Update existing schedules.
  </ParamField>

  <ParamField path="Duplicate schedules" type="Write">
    Duplicate a schedule.
  </ParamField>

  <ParamField path="Discover schedules" type="Write">
    Discover schedules from data sources and import them to KODE OS.
  </ParamField>

  <ParamField path="Sync schedules" type="Write">
    Sync schedule updates from the data source.
  </ParamField>

  <ParamField path="Delete schedules" type="Write">
    Delete schedules.
  </ParamField>
</Expandable>

<Expandable title="MultiTrend">
  <ParamField path="Get Trends" type="Read">
    Access the Trends module.
  </ParamField>

  <ParamField path="Publish Configurations" type="Write">
    Create views on the Trends module.
  </ParamField>
</Expandable>

<Expandable title="OSS">
  <ParamField path="Get OSS results" type="Read">
    View Optimal Set Point Strategy (OSS) results.
  </ParamField>

  <ParamField path="Create OSS configs" type="Write">
    Create OSS configurations.
  </ParamField>
</Expandable>

<Expandable title="MassWrite">
  <ParamField path="Get points latest configs" type="Read">
    View the past jobs for writing points from the portfolio view.
  </ParamField>

  <ParamField path="Get schedules latest configs" type="Read">
    View the past jobs for modifying schedules from the portfolio view.
  </ParamField>

  <ParamField path="Initiate schedule mass write" type="Write">
    Initiate a job for mass modifying schedules on buildings you can access from the portfolio view.
  </ParamField>

  <ParamField path="Initiate point mass write" type="Write">
    Initiate a job for mass writing points on buildings you can access from the portfolio view.
  </ParamField>
</Expandable>

<Expandable title="Audit">
  <ParamField path="Get audit templates" type="Read">
    Access the Audit module and view created tables.
  </ParamField>

  <ParamField path="Create audit templates" type="Write">
    Create new Audit tables in the Admin module of a building.
  </ParamField>

  <ParamField path="Delete audit templates" type="Write">
    Delete Audit tables in the Admin module of a building.
  </ParamField>
</Expandable>

<Expandable title="Connectivity">
  <ParamField path="Get tunnels" type="Read">
    Access the Connectivity module and view created tunnels.
  </ParamField>

  <ParamField path="Create tunnel" type="Write">
    Create a tunnel in the Connectivity module.
  </ParamField>

  <ParamField path="Delete tunnel" type="Write">
    Delete a tunnel in the Connectivity module.
  </ParamField>
</Expandable>

<Expandable title="Deployment Audit">
  <ParamField path="Get deployment audit reports" type="Read">
    Access the Deployment Audit module.
  </ParamField>

  <ParamField path="Get deployment audit report details" type="Read">
    Access the Deployment Audit report for a specific building.
  </ParamField>

  <ParamField path="Create deployment audit report" type="Write">
    Create a Deployment Audit report for a specific building.
  </ParamField>
</Expandable>

<Expandable title="Energy Dashboard">
  <ParamField path="Get energy dashboard" type="Read">
    Access the Energy Dashboard from the top main bar.
  </ParamField>
</Expandable>

<Expandable title="Marker Icons">
  <ParamField path="Get marker icons" type="Read">
    View the categories of marker icons from the Admin panel.
  </ParamField>

  <ParamField path="Manage marker icons" type="Write">
    Modify marker icons from the Admin panel.
  </ParamField>

  <ParamField path="Manage categories" type="Write">
    Modify the categories of marker icons from the Admin panel.
  </ParamField>

  <ParamField path="Manage marker styles" type="Write">
    Manage the styles of markers inside the edit mode of the graphics tool.
  </ParamField>
</Expandable>

<Expandable title="Dashboards">
  <ParamField path="Get dashboards" type="Read">
    View the Dashboards module when navigating to a building.
  </ParamField>

  <ParamField path="Create dashboards" type="Write">
    Create dashboards inside a building.
  </ParamField>

  <ParamField path="Delete dashboards" type="Write">
    Delete dashboards inside a building.
  </ParamField>

  <ParamField path="Share widgets" type="Write">
    Create a shareable link for a widget in a dashboard.
  </ParamField>
</Expandable>

### Users

Controls access to user management within the client organization.

<Expandable title="General">
  <ParamField path="Get users" type="Read">
    View the list of users in the Admin panel.
  </ParamField>

  <ParamField path="Assign buildings to users" type="Write">
    Assign buildings to users in the Admin panel.
  </ParamField>

  <ParamField path="Create users" type="Write">
    Create new users in the Admin panel.
  </ParamField>

  <ParamField path="Delete users" type="Write">
    Delete users in the Admin panel.
  </ParamField>
</Expandable>
