API identities in Dalux Build API

This article will show you how to set up API identities for the Dalux Build API.

API identities provide a way to access the Dalux Build API with specific permissions.

By creating an API Identity, you can specify the level of access to the system, whether it is access to all company data across all projects or limited access to certain groups on particular projects.

If you want to learn more about Dalux APIs, read this article: Dalux API.

How to set up API identities

API identities are set up in the company profile.

To create an API identity, go to Company profile Settings 'API identities'.

In the API identities window, you can create new identities and manage existing ones.

You can create multiple identities to manage access levels as needed. To set up a new API identity, click on Create.

• Name - The name of the API identity displayed in the interface. We suggest choosing a name that is both descriptive and clear.
• Email - The email entered here is responsible for validating the API via a confirmation email
• Company - The name of the company that the API identity is for (metadata)
• Company permissions - Only set this permission when the API identity should have access to data across all your projects. The company permissions match those of the company profile roles (Company administrator and Company observer). This can be changed after the Identity is created.
• Description - A brief description that includes details about the API identity, like access scope, contact info, or other relevant data.

After you provide the necessary information and agree to the API identity Terms and Conditions, a verification email will be sent to the email address you provided. If needed, the email can be resent. You cannot generate an API key until the identity has been verified.

After verifying the API identity, you can add project settings, which allow for more specific project access. This step is only necessary if you have not chosen any company access.

Click on 'Add project' to continue. Then select the project, and add the user group(s).

The selected user groups' permissions control what the API identity has access to on the project.

When you are done, click 'Add'.

Now, you can add an API key to the API identity. Click on 'Add API key' to proceed. When adding an API key, you must specify the duration of its validity.

An API key will now be generated. Copy the key and confirm that the key has been copied, then click 'OK'.

The API identity can now be used with the Dalux Build API.