HelloID-Conn-Prov-Target-Aura

Important

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-Aura
  • Table of contents
  • Introduction
  • Getting started
    • Provisioning PowerShell V2 connector
      • Field mapping
      • Correlation configuration
    • Connection settings
    • Prerequisites
    • Remarks
  • Setup the connector
  • Getting help
  • HelloID docs

Introduction

HelloID-Conn-Prov-Target-Aura is a target connector. Aura provides a set of REST API's that allow you to programmatically interact with its data. The HelloID connector uses the API endpoints listed in the table below.

Endpoint	Description
https://<yourenvironment.auralibrary>.nl/uPersonManagementServiceSync.asmx	There is only one endpoint used, the one specified in the BaseUrl, wich is the endpoint that receives all SOAP messages

The following lifecycle actions are available:

Action	Description
create.ps1	PowerShell create lifecycle action
disable.ps1	PowerShell disable lifecycle action
update.ps1	PowerShell update lifecycle action
configuration.json	Default Configuration.json
fieldMapping.json	Default FieldMapping.json

Getting started

Provisioning PowerShell V2 connector

Field mapping

The field mapping can be imported by using the fieldMapping.json file.

See the description of each field in this file (or in the Helloid Fields tab after import).

The Unique Id of the account to be created, should be provided in the LENERSCODE field.

Correlation configuration

The correlation configuration is used to specify which properties will be used to match an existing account within Aura to a person in HelloID.

To properly setup the correlation:

1. Make sure you have inported the field mapping, and configured the mapping for the LENERSCODE field.

2. Open the Correlation tab.

3. Specify the following configuration:

   Setting	Value
   Enable correlation	True
   Person correlation field	ExternalId
   Account correlation field	LENERSCODE

Tip

For more information on correlation, please refer to our correlation documentation pages.

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
Password	The Password to connect to the API	Yes
BaseUrl	The URL to the API - https://<yourenvironment.auralibrary>.nl/uPersonManagementServiceSync.asmx	Yes

Prerequisites

Remarks

The "Aura Account" data model , as specified by the HelloId field mapping, and as used by the Aura application database, is not directly serviced by the Aura API itself.

The Aura Api makes use of the much more general generic soap/xml data definition as defined in http://www.imsglobal.org/services/pms/xsd/imsPersonManMessSchema_v1p0 to transport the 'Aura account' information between HelloID to the Aura database.

Therefore the "Aura account" datamodel has to be converted to the generic Ims data model, before it can be used by the Aura API, and the other way around when information is read from the API.

This Ims format serves only as a transport mechanism. This format is not directly used in the fields mapping, as it would expose the unnessesary complexity of this model to the field mapping without any added functionality. The translation from the 'Aura account' as specified by HelloID to the ims schema en visa versa is therfore 'hardcoded' in the powershell connector, and the fields in HelloId are used to map the HelloID data to the "Aura account".

HelloID generates the values of the 'Aura account' by means of the field mapping. The meaning of the 'Aura account' fields is listed in the description of each field in the mapping.

• There is no delete functionality for an account in Aura. Accounts can however be disabled, by specifiying the UITSDATUM field. This is implemented in the disable.ps1. Accounts cannot be re-enabled by means of the connector. The UITSDATUM field is only to be used in the disable script and is the only field in that 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

Tip

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

Tip

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/