Follow

Working with API Permissions

Overview

API Permissions permissions allow the administrators to set up permissions on the API access to the CMMS data. The web-based CMMS has its own set of permissions (Set Up User Groups). However, the Mobile Application, as well as any custom API implementation setup in your company will now depend on the API permissions that are now available.

In the future, we will transition our whole system to work with API permissions, instead of the current settings (Set Up User Groups). This will ensure that all permissions are handled in a similar way.

 

Transition to the API Permissions

On Monday, February 2nd 2015, API permissions will be enabled. However, you will not start from scratch, as permissions will be automatically ported over from your existing Menu and Page permissions. As you can see in the table below, there isn't a 1:1 mapping between Menu and Page permissions and API permissions. In fact, we have considerably simplified the API Permissions compared to existing permissions!

This means that you may have to adjust your permissions so that they reflect your workflow entirely.

 

Customizing API Permissions

API Permissions are applied to User Groups. They are additive, meaning that if you belong to two different User Groups, you will inherit the API permissions from both groups.

API Permissions are located by clicking Settings, User Groups *Pick a group*, and API Permissions

 

The API Permissions page

"Infer API Permissions from Page Permissions" allow you to automatically let the software pick the API Permissions, based on the permissions you have setup in the Page Permissions. Remember, there isn't a 1:1 mapping between Menu and Page Permissions, and API Permissions. You'll have to check that API Permissions are setup the right way, but this is a great starting point.

The first pane shows the RPC calls available to that user group. At the moment, those are needed for the mobile application to work, so you cannot turn them off. As we add optional ones, you will be able to customize them.

The second panel shows you all the classes available through the API. Each of them has its permissions. You can check the permissions for each class as you need.

Permissions work following the CRUD standard. CRUD is the acronym for Create, Read, Update, Delete. You can read more about CRUD here. You can therefore choose whether members of the given group can view an item, change its properties, create a new one, or delete existing ones.

Some items are greyed out, like the "AssetCategory". This is because, just like with RPC calls, the mobile functionality relies heavily on it, and the mobile apps will not work at all without those.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk