Permissions

There are two different types of permissions, static permissions and resource permissions. Resource permissions control who has access to a report or endpoint. While static permissions give base access to functions. Both permissions are needed to perform an action on a specific resource.

Static permissions

Static permissions are granted per user or user group, in the OmniFi Admin application.

Static permissions limit what pages a user has access to in OmniFi Web, as well as what functions the user has access to.

Static permission description

Report permissions

Report permissions (Read, Execute, Modify) are granted per report, and limit the access users have to that specific reports.

E.g. access to execute a report is limited by both the static permission Reports/Execute and the Execute report permission.

Users granted Reports/Execute must have personal logins to the systems where data is fetched from.

Endpoint permissions

Endpoint permissions give access to data published via OmniFi API. They can be used to grant access to endpoints without grant access to the source report.

Page access

Available pages are controlled by static permissions. The page functionality also depends on the specific resource permission.

Report functional access

Report access is controlled by static and report permissions.

Read User Configuration

A read user should typically be able to read report logs, but not execute reports. Read users require the following permissions.

'Read' users require no static permissions, and only Read permission to each report.

Execute User Configuration

A user that needs to run reports and view the results require the following permissions.

'Execute' users require the static Execute permission , as well as Read and Execute permissions to each report.

Report tasks functional access

Schedule and task access is controlled by static and report permissions.

Schedules are administered centrally, their definitions only available under static permissions Web/Schedules/Admin or Web/Administer.

Report task results can be viewed by anyone with Read permission to the underlying report. Creating and modifying report tasks, on the other hand, require both access to executing the report (via static and resource permission), as well as the static _Create Task _permission.

Execute User Configuration

A user that should be able to read and execute tasks require the following permission configuration.

Create Task User Configuration

A user that should be able to create and execute tasks require the following permission configuration.

API functional access

API access is controlled by static, report and endpoint permissions.

Creating and managing endpoints requires Web/API/Administer static permission, without additional resource permissions.

Using endpoints through the OmniFi Access API requires both static and resource permission, either to the endpoint or to the underlying report. Snapshot endpoints require Read permission, whereas Function and Import endpoints require Execute permission.

Read User Configuration

A user that should be able to read but not execute API endpoints require the following permission configuration:

Or:

Execute User Configuration

A user that should be able to read and execute API endpoints require the following permission configuration.

Or:

Data Mart functional access

Creating and modifying Data Mart models and tables requires the static permission Web/Data Mart/Administer, and no resource permissions.

To be able to add new reports data sets, the static Web/Data Mart/Administer permission is required.