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-BasKMS is a target connector. BasKMS provides a set of REST API's that allow you to programmatically interact with its data. The HelloID connector uses the API endpoints listed in the table below.
| Endpoint | Description |
|---|---|
| /kms/employee/show | Retrieve a single employee by referenceId. |
| /kms/employee/create | Create a new employee. |
| /kms/employee/update | Update an employee. |
The following lifecycle actions are available:
| Action | Description |
|---|---|
| create.ps1 | PowerShell create lifecycle action |
| delete.ps1 | PowerShell delete lifecycle action |
| disable.ps1 | PowerShell disable lifecycle action |
| enable.ps1 | PowerShell enable lifecycle action |
| update.ps1 | PowerShell update lifecycle action |
| configuration.json | Default configuration.json |
| fieldMapping.json | Default fieldMapping.json |
The correlation configuration is used to specify which properties will be used to match an existing account within BasKMS to a person in HelloID.
To properly setup the correlation:
-
Open the
Correlationtab. -
Specify the following configuration:
Setting Value Enable correlation TruePerson correlation field PersonContext.Person.ExternalIdAccount correlation field referenceId
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 following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| ClientID | The ClientID to connect to the API | Yes |
| ClientSecret | The ClientSecret to connect to the API | Yes |
| UserName | The UserName to connect to the API | Yes |
| Password | The Password to connect to the API | Yes |
| BaseUrl | The base URL to the API | Yes |
The referenceId contains the externalId of the person. This field is used within the create lifecycle action to determine if an account exists and is part of the JSON payload to the target application.
Important
The referenceId can only be filled with the API or with an import (not in the GUI).
Most of the errors in BasKMS are returned in the response. For this reason, the code will check the response if it contains an error.
The data returned by KMS also could also contain the social security number or BSN. Therefore, within the connector, both the output from $correlatedAccount and $createdAccount are filtered to only contain the fields specified in the field mapping or $actionContext.Data with the addition of the id.
The field mapping contains a field departmentName, which is returned by BasKMS as department.name. In the update script, this is hardcoded to departmentName.
Important
If departmentName is not present, BasKMS will set the department field to empty without returning an error.
How to setup the connector in HelloID. Are special settings required. Like the primary manager settings for a source connector.
Tip
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages.
Tip
If you need help, feel free to ask questions on our forum.
The official HelloID documentation can be found at: https://docs.helloid.com/