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-GoodHabitz is a target connector. GoodHabitz The purpose of this connector is to only delete a person from GoodHabitz using the persons Active Directory email address.
| Endpoint | Description |
|---|---|
| /person/forget | Endpoint for removing accounts from GoodHabitz. |
The following lifecycle actions are available:
| Action | Description |
|---|---|
| create.ps1 | PowerShell create lifecycle action |
| delete.ps1 | PowerShell delete lifecycle action |
| configuration.json | Default configuration.json |
| fieldMapping.json | Default fieldMapping.json |
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 |
|---|---|---|
| ApiKey | The ApiKey to connect to the API | Yes |
| BaseUrl | The URL to the API | Yes |
Within the create lifecycle action, the $outputContext.AccountReference is set to: $actionContext.Data.EmailAddress. However, the account reference is not being used within the delete lifecycle action since the account reference is not being updated.
The purpose of this connector is to only remove an account from GoodHabitz.
Important
The account will be marked for deletion in Good Habitz. Good Habitz has an internal retention time before the account is deleted. By default, this time is 5 days.
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/
