Important
This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements.
HelloID-Conn-Prov-Target-HelloID is a target connector. HelloID provides a set of REST APIs that allow you to programmatically interact with its data.
The following features are available:
| Feature | Supported | Actions | Remarks |
|---|---|---|---|
| Account Lifecycle | ✅ | Create, Update, Enable, Disable, Delete | |
| Permissions | ✅ | Retrieve, Grant, Revoke | Static or Dynamic |
| Resources | ✅ | Retrieve, Create | Groups only |
| Entitlement Import: Accounts | ✅ | - | |
| Entitlement Import: Permissions | ✅ | - | Groups, Products |
| Governance Reconciliation Resolutions | ✅ | - |
URL of the icon used for the HelloID Provisioning target system.
https://raw.githubusercontent.com/Tools4everBV/HelloID-Conn-Prov-Target-HelloID/refs/heads/main/Icon.png
- HelloID Provisioning agent (cloud or on-prem).
- HelloID environment.
- Access to the HelloID API.
- API Key
- API Secret
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| Base URL | The URL to the API | Yes |
| Api key | The key to connect to the API | Yes |
| Api secret | The secret to connect to the API | Yes |
| Set manager | As we use the AccountReference of the manager for this, HelloID has to have granted the Account entitlement for the manager first. | No |
| UpdateUserName | When toggled, the username will be updated | No |
The correlation configuration is used to specify which properties will be used to match an existing account within HelloID to a person in HelloID.
| Setting | Value |
|---|---|
| Enable correlation | True |
| Person correlation field | Accounts.EntraID.userPrincipalName |
| Account correlation field | UserName |
Tip
For more information on correlation, please refer to our correlation documentation pages.
The field mapping can be imported by using the fieldMapping.json file.
The account reference is populated with the property userGUID from HelloID.
- The product grant script only requests the product in case it has not been assigned for the account yet.
- The product revoke script revokes all assignments for the requested product.
The following endpoints are used by the connector
| Endpoint | HTTP Method | Description |
|---|---|---|
| /api/v1/users | GET, POST | Retrieve and create user information |
| /api/v1/users/{UserId} | GET, PUT | Retrieve and update specific user information |
| /api/v1/users/{UserId} | DELETE | Delete a user |
| /api/v1/groups | GET, POST | Retrieve and create groups |
| /api/v1/groups/{GroupId} | GET | Retrieve specific group |
| /api/v1/users/{UserId}/groups | POST | Grant group to user |
| /api/v1/{UserId}/groups/{GroupId} | DELETE | Revoke group from user |
| /api/v1/products | GET | Retrieve products |
| /api/v1/selfservice/products/request | POST | Request product for user |
| /api/v1/product-assignment | GET | Retrieve product assignments |
| /api/v1/product-assignment/by-user/{Id} | GET | Retrieve product assignments by user |
| /api/v1/product-assignment/unassign/by-product | POST | Unassign product from user |
Tip
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages.
The official HelloID documentation can be found at: https://docs.helloid.com/