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-RAET-FileAPI-DPIA100 is a target connector for creation of DPIA100 through RAET's RAET-FileAPI-DPIA100 API (Beaufort)
This connector contains the DPIA100 target for creating a DPIA100 export for Raet Beaufort to import some generated data from the HelloID provisioning module. This functionality will at one moment be replaced by writing back the desired values by the IAM-API (not supported yet)
This version is created for export only rubriekcode P01035 (emailaddress work)
Please setup the connector following the DPIA100 requirements of the customer. You can choose between an export per day, or a DPIA100 export per person.
| Endpoint | Description |
|---|---|
| https://connect.visma.com/connect/token | Retrieve access token |
| https://fileapi.youforce.com | DPIA100 endpoint |
The following lifecycle actions are available:
| Action | Description |
|---|---|
| create.ps1 | PowerShell create 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 RAET-FileAPI-DPIA100 to a person in HelloID.
To properly setup the correlation:
-
Open the
Correlationtab. -
Specify the following configuration:
Setting Value Enable correlation FalsePerson correlation field `` Account correlation field ``
[!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 |
|---|---|---|
| DPIA100 FILE PREFIX | Prefix for Dpia100 file | Yes |
| DPIA100 CREATIEGEBRUIKER | User used for creating Dpia100 file | Yes |
| DPIA100 PROCESCODE | Processing code | Yes |
| DPIA100 STAM | Stam code | Yes |
| Client ID | The Client ID to connect with the FileAPI (created when registering the App in in the Visma Developer portal). | Yes |
| Client Secret | The Client Secret to connect with the FileAPI (created when registering the App in in the Visma Developer portal). | Yes |
| Tenant ID | The Tenant ID to specify to which Raet tenant to connect with the FileAPI (available in the Visma Developer portal after the invitation code has been accepted). | Yes |
Important
The latest version of this connector requires new api credentials. To get these, please follow the Visma documentation on how to register the App and grant access to client data.
- Enabling of the User endpoints.
- By default, the User endpoints aren't "enabled". This has to be requested at Raet.
- File processing.
- When using the Tenant ID and BusinessTypeID (101020), files should automatically be processed in Beaufort.
- ClientID, ClientSecret and tenantID
- Since we are using the API we need the ClientID, ClientSecret and tenantID to authenticate with RAET IAM-API Webservice.
- Dependent account data in HelloID.
- Please make your provisioned system dependent on this Users Target Connector and make sure that the values needed to be written back are stored on the account data (e.g UserPrincipalName).
Tip
This version is created for export only 'rubriekcode' P01035 (emailaddress work).
When the value in Raet equals the value in HelloID, the action will be skipped (no update will take place).
[!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/