Prerequisites

Please carefully read the following to make sure you fulfill all the requirements to set up the integration:

In order to set up the integration with Humaans, your user role permissions must include:

• Create and use API access tokens

To validate that you have these permissions:

1. Click on the 3-dot menu in the top left. You should be able to see API access tokens in the menu
   
2. Verify that you are able to see the Generate new token button
   

If you can not follow these steps, you do not have sufficient permissions to set up this integration. Please ask a system administrator to assign these permissions to your account. An administrator can edit user permissions here. Updating user permissions is also explained in more detail below.

Instructions

Creating a Humaans API token with the correct permissions involves two steps:

• The API token must be created with the correct set of scopes.
• The user who creates the API token must be assigned to a role with permissions to access the desired fields.

For admins in the Humaans system, it will not be necessary to ensure that the user role has sufficient permissions, as they can view all data points by default. Other user roles may lack the required permissions to read the required data. To solve this, admins can create custom user roles to assign employees to (more on that below under Updating the User Role).

Creating an API key

1. Log into Humaans, then click on the 3-dot menu in the top left, then on "API access tokens":
   
   
   
2. Click on "Generate new token":
   
   
   
3. Next, enter a label for the token and select the required API token scopes:
   
   You will find all the required API token scopes in the connection flow:
   
   Note: These scopes above are an example, they might differ in your case.
4. Click on Create access token, then Click to copy:
   
5. Paste the value you copied into the connection flow, then "Set up integration":
   

Updating the User Role

To update a user role, an admin can create or update user roles in the Humaans dashboard.

The user who creates the API token must have access to all User role permissions listed in the connection flow: