Configure Connection
Tools4ever HelloID guide
Generate an API key and secret in HelloID, configure the tenant connection in NIM, and validate user and access data.
Before you beginDirect link to Before you begin
Follow HelloID's Generate an API key documentation. Create a separate key for NIM so it can be managed independently of other integrations.
NIM requires Tenant URL, API Key, and API Secret.
Create the key and secretDirect link to Create the key and secret
- In HelloID, go to Security > API and select Add API Key.
- Enable Show Secret and copy the Key and Secret to secure storage.
- Optionally configure Allowed IP Addresses to restrict the key to approved addresses. Ensure the NIM server's public egress address is allowed.
- If you enable Use Agent IP Addresses, confirm that the NIM server's requests originate from an allowed HelloID Agent address.
- Select Save.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Tools4ever HelloID system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The HelloID tenant API address for your environment, using the format expected by the Connection screen. |
| API Key | The Key generated in HelloID. |
| API Secret | The corresponding Secret. |
Test user retrievalDirect link to Test user retrieval
-
Select Test Connection. NIM attempts to retrieve a single user using:
GET /api/v1/users?take=1&skip=0 -
If the test fails, verify the Tenant URL, API Key, API Secret, network access, and any API key IP restrictions.
-
Collect users, groups, memberships, roles, and applications required by your process and validate identity and access mappings.
-
Test intended user lifecycle and group changes with safe records before enabling automation.
The connection test checks user retrieval. Validate other collections and each intended write operation separately. The connector lists membership, role, and application collections as read-only; group creation and updates are supported.