HelloID-Conn-Prov-Source-Caci-Osiris

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

• Introduction
• Getting started
  • Connection settings
  • Prerequisites
  • Remarks
• Setup the connector
• Getting help
• HelloID Docs

Introduction

HelloID-Conn-Prov-Source-Caci-Osiris is a source connector. Caci-Osiris provides a set of REST API's that allow you to programmatically interact with it's data. The HelloID connector uses the API endpoints listed in the table below.

Endpoint	Description
/basis/student	Used to retrieve the students
/generiek/student	Used to retrieve the student education information
/generiek/student/zoek/	Used to retrieve the student education information

When classes and groups needs to be included the additional API endpoint are necessary

Endpoint	Description
/generiek/studentgroep	Used to retrieve the groups / classed education information
/generiek/studentgroep/student	Used to retrieve the student from groups / classed education information

Getting started

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
BaseUrl	The URL to Caci Osiris.	Yes
ApiKey	The ApiKey to connector to Caci Osiris. ApiKeys are generated within the application.	Yes
SchoolName	The name of the school for which the data will be fetched	Yes
Limit	The limit of students that will be fetched from Caci Osiris and imported in HelloID	Yes
Isdebug	When toggled, debug logging will be displayed	No

Prerequisites

• Enable the webservices

Remarks

Rate limiting

Currently the HelloID-Conn-Prov-Source-Caci-Osiris connector works as follows:

1. First retrieve all students from Caci Osiris using a GET /studenten.
2. For each student; we have to do a GET /studenten/studentNummer to get a 'so called' richStudent object containing information about the educations.

So, if an organization has a large number of students, a lot of API calls will have to be made.

The Caci Osiris API is rate limited to a max of 50 requests per second. Therefore;

1. First we retrieve all students and store them in the $responseStudents object.

  $responseStudents = Invoke-RestMethod @splatParam

2. For each individual student we will fetch the richStudentData data from Caci Osiris with a 1 second interval between each batch.

  $persons | ForEach-Object {
    $splatGetAdditionalStudentdataParams = @{
        Uri     = "$($config.BaseUrl)/basis/student?p_studentnummer=$($_.studentnummer)"
        Headers = $headers
        Method  = 'GET'
    }
    $responseAdditionalStudentdata = Invoke-RestMethod @splatGetRichStudentParams -Verbose:$false
    ...
    Start-Sleep -Seconds 20
  }

Setup the 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/