HelloID-Conn-Prov-Target-HelloID

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

Introduction

HelloID-Conn-Prov-Target-HelloID is a target connector. HelloID 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
/api/v1/users/{UserId}	Get specific user account (GET)
/api/v1/users/	Create user accounts (POST)
/api/v1/users/{UserId}	Update user accounts (PUT)
/api/v1/users/{UserId}	Delete user accounts (DELETE)
/api/v1/groups	Get all groups (GET)
/api/v1/users/{UserId}/groups	Grant group to user (POST)
/api/v1/{UserId}/groups/{GroupId}	Revoke group from user (DELETE)
/api/v1/groups	Create groups (POST)
/api/v1/selfservice/products	Get all products (GET)
/api/v1/selfservice/products/request	Request a product for a user (POST)

The following lifecycle actions are available:

Action	Description
create.ps1	Create or correlate to an account
delete.ps1	Delete an account
disable.ps1	Disable an account
enable.ps1	Enable an account
update.ps1	Update an account
permissions.groups.ps1	List groups as permissions
grantPermission.groups.ps1	Grant groupmembership to an account
revokePermission.groups.ps1	Revoke groupmembership from an account
permissions.products.ps1	List products as permissions
grantPermission.products.ps1	Request product for an account
revokePermission.products.ps1	Note: there is no functionality to "unrequest" a product, therefore this is just an empty script
resources.groups.ps1	Create group based on HR data
configuration.json	Default configuration.json
fieldMapping.json	Default fieldMapping.json

Getting started

By using this connector you will have the ability to seamlessly create and manage user accounts and groups in HelloID. Additionally, you can request products for users, enhancing your workflow. It's important to note that at this time, there isn't a feature to "unrequest" a product.

Connecting to HelloID is straightforward. Simply utilize the API Key and API Secret pair. For further details, refer to the following pages in the HelloID Docs:

Generate an API key. API docs

HelloID Icon URL

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

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

Provisioning PowerShell V2 connector

Correlation configuration

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

To properly setup the correlation:

1. Open the Correlation tab.

2. Specify the following configuration:

   Setting	Value
   Enable correlation	True
   Person correlation field	``
   Account correlation field	UserName

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.

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
Base URL	The URL to the API	Yes
Api key	The key to connect to the API	Yes
Api secret	The secret to connect to the API	Yes
Set manager	As we use the AccountReference of the manager for this, HelloID has to have granted the Account entitlement for the manager first.	No
UpdateUserName	When toggled, the username will be updated	No
IsDebug	When toggled, extra logging is shown. Note that this is only meant for debugging, please switch this off when in production.	No

Prerequisites

• HelloID Provisioning agent (cloud or on-prem).
• HelloID environment.
• Access to the HelloID API.
  • API Key
  • API Secret

Remarks

There is no functionality to "unrequest" a product, therefore this is just an empty 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/