{"id":19504878,"url":"https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-Magister-Student-UpdateEmail","last_synced_at":"2025-04-26T00:33:42.898Z","repository":{"id":113210522,"uuid":"419306638","full_name":"Tools4everBV/HelloID-Conn-Prov-Target-Magister-Student-UpdateEmail","owner":"Tools4everBV","description":"Magister - Target Student Update Email","archived":false,"fork":false,"pushed_at":"2025-04-14T11:39:47.000Z","size":148,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-14T12:40:33.365Z","etag":null,"topics":["edu","sis"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tools4everBV.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-20T11:46:12.000Z","updated_at":"2024-11-21T19:06:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"89174895-d5cd-44e9-8c85-341072a45e39","html_url":"https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-Magister-Student-UpdateEmail","commit_stats":null,"previous_names":["tools4everbv/helloid-conn-prov-target-magister-student-updateemail","tools4everbv/helloid-conn-prov-target-magister"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tools4everBV","download_url":"https://codeload.github.com/Tools4everBV/HelloID-Conn-Prov-Target-Magister-Student-UpdateEmail/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250917283,"owners_count":21507561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["edu","sis"],"created_at":"2024-11-10T22:27:31.574Z","updated_at":"2025-04-26T00:33:42.890Z","avatar_url":"https://github.com/Tools4everBV.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HelloID-Conn-Prov-Target-Magister-Student-UpdateEmail\n\n\u003e [!IMPORTANT]\n\u003e 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.\n\n\u003e [!WARNING]\n  This connector is not tested with a Magister environment!\n\n\u003cp align=\"center\"\u003e\n \u003cimg src=\"assets/logo.png\"\u003e\n\u003c/p\u003e\n\n## Table of contents\n\n- [HelloID-Conn-Prov-Target-Magister-Student-UpdateEmail](#helloid-conn-prov-target-connectorname)\n  - [Table of contents](#table-of-contents)\n  - [Introduction](#introduction)\n  - [Getting started](#getting-started)\n    - [Prerequisites](#prerequisites)\n    - [Connection settings](#connection-settings)\n    - [Correlation configuration](#correlation-configuration)\n    - [Available lifecycle actions](#available-lifecycle-actions)\n    - [Field mapping](#field-mapping)\n  - [Remarks](#remarks)\n  - [Development resources](#development-resources)\n    - [API endpoints](#api-endpoints)\n    - [API documentation](#api-documentation)\n  - [Getting help](#getting-help)\n  - [HelloID docs](#helloid-docs)\n\n## Introduction\n\n_HelloID-Conn-Prov-Target-Magister_ is a _target_ connector.\nThis 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.\n\n## Getting started\n\n### Prerequisites\n- Access to the magister api url.\n- The user must be authorized for the function 'UpdateLeerEMail'\n\n### Connection settings\n\nThe following settings are required to connect to the API.\n\n| Setting  | Description                        | Mandatory |\n| -------- | ---------------------------------- | --------- |\n| UserName | The UserName to connect to the API | Yes       |\n| Password | The Password to connect to the API | Yes       |\n| BaseUrl  | The URL to the API Example: https://mycompany.swp.nl:8800   | Yes       |\n\n### Correlation configuration\n\nThe correlation configuration is Not used by this connector as no correlation is done.\nThe StamNr field in the _fieldmapping_json_ file is used to identify the Magister account to update\n\n| Setting                   | Value                             |\n| ------------------------- | --------------------------------- |\n| Enable correlation        | `false`                           |\n        |\n\n\n### Available lifecycle actions\n\nThe following lifecycle actions are available:\n\n| Action                                  | Description                                                                        |\n| --------------------------------------- | -----------------------------------------------------------------------------------|\n| create.ps1                              | Sets a (new) email address for the student                                         |\n| update.ps1                              | Updates the email addres of a student.                                             |\n| configuration.json                      | Contains the connection settings and general configuration for the connector.      |\n| fieldMapping.json                       | Defines mappings between person fields and target system person account fields.    |\n\n### Field mapping\n\nThe field mapping can be imported by using the _fieldMapping.json_ file.\n\n## Remarks\n\n- Execute on-premises because of IP whitelisting on Magister site\n- The user must be authorized for the function 'UpdateLeerEMail'\n- 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.\n- 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.\n\n## Development resources\n\n### API endpoints\n\nThe following endpoints are used by the connector\n\n| Endpoint | Description               |\n| -------- | ------------------------- |\n| /doc?Function=UpdateLeerEMail\u0026Library=ADFuncties  | used for the update of the studend email   |\n\n\n### API documentation\n\n- Documentation can be found at https://\u003ctenant\u003e.swp.nl:8800/doc?, https://\u003ctenant\u003e.nl:8800/doc?#Service_ADFuncties, https://\u003ctenant\u003e.swp.nl:8800/doc?#Service_Data\n\n## Getting help\n\n\u003e [!TIP]\n\u003e _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/en/provisioning/target-systems/powershell-v2-target-systems.html) pages_.\n\n\u003e [!TIP]\n\u003e  _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_.\n\n## HelloID docs\n\nThe official HelloID documentation can be found at: https://docs.helloid.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTools4everBV%2FHelloID-Conn-Prov-Target-Magister-Student-UpdateEmail/lists"}