Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tools4everbv/helloid-conn-prov-target-eduarte-student

Eduarte - Target - Students
https://github.com/tools4everbv/helloid-conn-prov-target-eduarte-student

edu provisioning sis

Last synced: about 1 month ago
JSON representation

Eduarte - Target - Students

Awesome Lists containing this project

README 

        

# HelloID-Conn-Prov-Target-Eduarte-Student



| :information_source: 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](#helloid-conn-prov-target-eduarte-student)

  - [Table of contents](#table-of-contents)

  - [Introduction](#introduction)

  - [Getting started](#getting-started)

    - [Connection settings](#connection-settings)

    - [Prerequisites](#prerequisites)

    - [Remarks](#remarks)

  - [Setup the connector](#setup-the-connector)

  - [Getting help](#getting-help)

  - [HelloID docs](#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](https://docs.helloid.com/hc/en-us/articles/360012558020-Configure-a-custom-PowerShell-target-system) pages_



> _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_



## HelloID docs



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