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.
Warning
This connector is not tested with a Magister environment!
HelloID-Conn-Prov-Target-Magister is a target connector. This connector is currently only used to create or update the de email addresses of existing students in Magister. It does not manage the Magister students lifecycle.
- Access to the magister api url.
- The user must be authorized for the function 'UpdateLeerEMail'
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| UserName | The UserName to connect to the API | Yes |
| Password | The Password to connect to the API | Yes |
| BaseUrl | The URL to the API Example: https://mycompany.swp.nl:8800 | Yes |
The correlation configuration is Not used by this connector as no correlation is done. The StamNr field in the fieldmapping_json file is used to identify the Magister account to update
| Setting | Value |
|---|---|
| Enable correlation | false |
|
The following lifecycle actions are available:
| Action | Description |
|---|---|
| create.ps1 | Sets a (new) email address for the student |
| update.ps1 | Updates the email addres of a student. |
| 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.
- Execute on-premises because of IP whitelisting on Magister site
- The user must be authorized for the function 'UpdateLeerEMail'
- There are no Get-calls available. The Student accounts that is updated in the create script is the account with the specified StamNr. This StamNr is stored as account reference.
- It does use an https POST action to invoke a specific library and function in the magister evironment, but the body of the call is not used.
The following endpoints are used by the connector
| Endpoint | Description |
|---|---|
| /doc?Function=UpdateLeerEMail&Library=ADFuncties | used for the update of the studend email |
- Documentation can be found at https://.swp.nl:8800/doc?, https://.nl:8800/doc?#Service_ADFuncties, https://.swp.nl:8800/doc?#Service_Data
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/