HelloID-Conn-Prov-Target-MultiBel

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-MultiBel
  • Table of contents
  • Introduction
  • Supported features
  • Getting started
    • HelloID Icon URL
    • Requirements
    • Connection settings
    • Correlation configuration
    • Field mapping
    • Account Reference
  • Remarks
    • FieldMapping
    • API Limitation
  • Development resources
    • API endpoints
    • API documentation
  • Getting help
  • HelloID docs

Introduction

HelloID-Conn-Prov-Target-MultiBel is a target connector. MultiBel provides a set of REST APIs that allow you to programmatically interact with its data.

Supported features

The following features are available:

Feature	Supported	Actions	Remarks
Account Lifecycle	✅	Create, Update, Enable, Disable, Delete
Permissions	❌	-
Resources	❌	-
Entitlement Import: Accounts	✅	-
Entitlement Import: Permissions	❌	-
Governance Reconciliation Resolutions	✅	-

Getting started

HelloID Icon URL

URL of the icon used for the HelloID Provisioning target system.

https://raw.githubusercontent.com/Tools4everBV/HelloID-Conn-Prov-Target-MultiBel/refs/heads/main/Icon.png

Requirements

• Connection settings: API Key, Base URL

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
API Key	The API-Key to connect to the API	Yes
BaseUrl	The URL to the API	Yes

Correlation configuration

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

Setting	Value
Enable correlation	True
Person correlation field	PersonContext.Person.ExternalId
Account correlation field	personId

Tip

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

Field mapping

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

Account Reference

The account reference is populated with the property multibelPersonId property from MultiBel

Remarks

FieldMapping

• JobCategories: In MultiBel, a user can have multiple job categories. The connector is configured to set only a default job category during creation. And will not be updated afterwards. In the Import script the job categories are listed comma separated.
• Values must exist: The Field JobCategories and rolName must be configured with existing values in MultiBel.

API Limitation

• PhoneNumbers:
  The API supports 1 - 10 phone numbers, in different properties. There is a difference between the GET and PUT call. There is some extra logic in the connector to handle this. The connector currently does not support adding or updating the phone numbers.

Development resources

API endpoints

The following endpoints are used by the connector

Endpoint	HTTP Method	Description
/api/v2/Persons/Person?PersonId	GET	Retrieve (correlate) user information
/api/v2/Persons/Person?MultiBelPersonId	GET, DELETE	Retrieve and delete user information
/api/v2/Persons/Person	POST, PUT	Create and update user information
/api/v2/Persons/Persons	GET	Retrieve all users information (import)

API documentation

• Swagger documentation

Getting help

Tip

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

HelloID docs

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