API identities in Dalux FM API

This article will explain how to set up API identities in FM.

Using an API identity allows for granular access to the Dalux FM API, using existing user roles and region logic. This allows for API access to be restricted to only the necessary data.

How to set up API identities

To create an API identity, go to:

Settings Integrations 'API identities':

To create a new API identity, click Add.

• Identity type - You have two choices
  • General - Direct access to data in the FM instance
  • Company - External supplier access to data, as set up in the company settings
• Name - Name of the API identity (can be changed later)
• Email - Email used for communication regarding Dalux API services and the use of the API identity (cannot be changed once the API identity has been created)
• Administrator - Overwrites any user role's permission and gives access to all data. For the 'Company' identity type, it gives company administrator access.
• Description - An optional description for the API identity to help you and others later

After filling in the required information, reading, and accepting the terms and conditions, click 'Create' to continue setting up the API identity.

You can now assign user roles and regions to the API identity. These determine which data is accessible via the API. For example, you cannot access work order data if the assigned user roles do not have access to work orders.

If the API identity has administrator permissions, it overwrites any permissions in the user roles and gives access to all data.

To add user roles and regions to the API identity, click on 'Add' in the user roles area.

You can add user roles on their own, or also specify a region for the user role.

Once you have added your user roles, you can start creating API keys. To create API keys for the API identity, click on 'Add' in the API keys area. When creating an API key, you have to specify the expiration time for the key.

When you click 'Add', the API key will be generated.

Copy the key and distribute it according to the terms and conditions. The API identity can now use its API key, limited to the API specified by the user's role access.