README.md

HelloID-Conn-Prov-Source-Anthology-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.

HelloID Provisioning Source Connector for Anthology Student

Table of Contents

• Getting Started
• Requirements
• Configure API Access

Getting Started

By using this connector you will have the ability to import data into HelloID:

• Student Demographics

Requirements

• API Access

Configure API Access

To configure Key Based Authentication, please follow these steps

• Location - Select Settings > System > Application API Keys
  • Product Help Link

• Encode the Application Key with Base64. Encode the value and share it with client/vendor
  • CallingAppName: Calling Application Name
  • KeyValue: Application Key

{"CallingAppName":"DualEnrollAPI","KeyValue":"YsIQkq2Hj/viKSM5Lzn07Q=="}

Setup the PowerShell connector

1. Add a new 'Source System' to HelloID and make sure to import all the necessary files.

   • configuration.json
   • persons.ps1
   • departments.ps1

2. Fill in the required fields on the 'Configuration' tab.

• Base URI
  • URI of Instance
• Application Key
  • API Key
• Page Size
  • Size of Results to pull back per page
• Student Fields
  • Fields to pull from Student Endpoint
• Include Statuses
  • Student Statuses to include in HelloID Import (no value results in all statuses)
• Exclude Shifts
  • Shifts to exclude from Import (no value results no filtering of shifts)

HelloID Docs

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