HelloID-Conn-Prov-Target-Eduarte-Student

ℹ️ Information
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.

Table of contents

• HelloID-Conn-Prov-Target-Eduarte-Student
  • Table of contents
  • Introduction
  • Getting started
    • Connection settings
    • Prerequisites
    • Remarks
  • Setup the connector
  • Getting help
  • HelloID docs

Introduction

HelloID-Conn-Prov-Target-Eduarte-Student is a target connector. Eduarte-Student provides a set of REST API's that allow you to programmatically interact with its data. This connector only correlates HelloID persons with Student accounts and updates the Email Address (or Username.)

The following lifecycle events are available:

Event	Description	Notes
create.ps1	Create-correlate, update-correlate and correlate an Account and update Mail (and Username)	Username is not implemented due to uncertainty in the Webservice
update.ps1	Update the Account	-
enable.ps1	Enable the Account	-
disable.ps1	Disable the Account	-
delete.ps1	n/a	-

Getting started

Connection settings

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

Prerequisites

Remarks

• This update in this connector only updates the EmailAddress, and probably the username but how must be verified during implementation.
• The property email does not exist as a fixed property on a update or student-GET. The "soort" may differ per implementation and can be set in the configuration.
• There is no Username Property present in de Deelnemers WSDL, We must look into this. The UMRA (Paid service) Does contain a Username property. This can be verified with a working test environment.
• When adding properties don't forget to also add them to the compare in the update script.

Setup the connector

How to setup the connector in HelloID. Are special settings required. Like the primary manager settings for a source connector.

Getting help

For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages

If you need help, feel free to ask questions on our forum

HelloID docs

The official HelloID documentation can be found at: https://docs.helloid.com/