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.
| Note that this connector is not yet implemented nor tested on a HelloID environment. Contact our support for further assistance |
HelloID-Conn-Prov-Target-Caci-Osiris-Update-Email is a target connector. Caci-Osiris-Update-Email provides a set of REST API's that allow you to programmatically interact with its data.
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| ApiKey | The ApiKey to connector to Caci Osiris. ApiKeys are generated within the application. | Yes |
| BaseUrl | The URL to Caci Osiris. | Yes |
The correlation configuration is used to specify which properties will be used to match an existing account within Caci-Osiris-Update-Email to a person in HelloID.
| Setting | Value |
|---|---|
| Enable correlation | True |
| Person correlation field | PersonContext.Person.ExternalId |
| Account correlation field | p_studentnummer |
Tip
For more information on correlation, please refer to our correlation documentation pages.
The following lifecycle actions are available:
| Action | Description |
|---|---|
| create.ps1 | Correlates the account on student number (does not create the account if not found). |
| delete.ps1 | Removes/clears the email address of the account. |
| update.ps1 | Updates the email address of an account. |
| configuration.json | Contains the connection settings and general configuration for the connector. |
| fieldMapping.json | Defines mappings between person fields and target system person account fields. |
The field mapping can be imported by using the fieldMapping.json file.
Note that this connector only updates the email address for a student. The create.ps1 does not create accounts but merely correlates a HelloID person with a Caci-Osiris student
The following endpoints are used by the connector
| Endpoint | Description |
|---|---|
| /basis/student/contactgegevens | Used to retrieve and update a student |
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/