HelloID-Conn-Prov-Target-RAET-Beaufort-IAM-API-Contact-Details

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.

Important

The latest version of this connector requires new api credentials. To get these, please follow the Visma documentation on how to register the App and grant access to client data.

Requirements

Table of contents

• HelloID-Conn-Prov-Target-RAET-Beaufort-IAM-API-Contact-Details
  • Table of contents
  • Introduction
  • Getting started
    • App within Visma
    • Scope Configuration within Visma
    • Provisioning PowerShell V2 connector
      • Correlation configuration
      • Field mapping
    • Connection settings
    • Prerequisites
    • Remarks
  • Getting help
  • HelloID docs

Prerequisites

• HelloID Provisioning agent (cloud or on-prem).
• HelloID environment.
• Authorized Visma Developers account in order to request and receive the API credentials in the Visma Developer portal. Please follow the Visma documentation on how to register the App and grant access to client data.
• ClientID, ClientSecret and tenantID to authenticate with the IAM API of Raet Beaufort. Please follow the Visma documentation on how to register the App and grant access to client data.
• Dependent account data in HelloID.
  • Please make your provisioned system dependent on this Users Target Connector and make sure that the values needed to be written back are stored on the account data (e.g UserPrincipalName).
• Configured Beaufort to automatically process import.
  • The mutations are submitted to Beaufort through the API using the fixed process code IDA. In order for the mutations to be processed automatically, a few checkboxes need to be ticked by the client. The application administrator can do this from the configuration import process screen. The green checkboxes must be ticked for process code IDA.

Remarks

• Currently, only the 'Business Email Address' and 'Business Phone Number' fields can be updated, no other fields are (currently) supported.

  When the value in Raet Beaufort equals the value in HelloID, the action will be skipped (no update will take place).

• The endpoint operates asynchronously. The data is first stored and internally verified before being submitted to BO4. To track the processing in the API, a ticketId is returned. The ticket ID must be used to check the status of the API call. Within the API, various checks are performed. For example, it checks that the email address matches the format aaaa@bbbb.xxx. It also checks that the phone number does not contain alphanumeric values. However, it does support phone numbers like "035-1234567".

Introduction

HelloID-Conn-Prov-Target-RAET-Beaufort-IAM-API-Contact-Details is a target connector. RAET-Beaufort 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
/iam/v1.0/persons/{id}	Documentation
/iam/v1.0/ContactDetails/{id}	Documentation

The following lifecycle actions are available:

Action	Description
create.ps1	Correlation on person
delete.ps1	Empty configured field(s) on person
update.ps1	Update configured field(s) on person
configuration.json	Default configuration.json
fieldMapping.json	Default fieldMapping.json

Getting started

App within Visma

First an App will have to be created in the Visma Developer portal. This App can then be linked to specific scopes and to a client, which will only be available after the invitation has been accepted. Please follow the Visma documentation on how to register the App and grant access to client data.

Scope Configuration within Visma

Before the connector can be used to retrieve and update employee information, the following scopes need to be enabled and assigned to the connector. If you need help setting the scopes up, please consult your Visma contact.

• Youforce-IAM:Get_Basic
• Youforce-IAM:Write_Basic

Note: When using any of the other Raet IAM API connectors, additional scopes are required.

• For HelloID-Conn-Prov-Source-Raet-Beaufort-IAM-API, used to import the HR data from Beaufort into HelloID Provisioning, the following scopes are required:
  • Youforce-IAM:Get_Basic
  • Youforce-Extensions:files:Get_Basic
• For HelloID-Conn-Prov-Target-Raet-Beaufort-IAM-API-Identity, used to write back the identity field, which is used for SSO, in Youforce, the following scopes are required:
  • Youforce-IAM:Update_Identity
• For HelloID-Conn-Prov-Target-Raet-DPIA100-FileAPI, used to write back the data to Beaufort, e.g. the business email address, the following scopes are required:
  • youforce-fileapi:files:list
  • youforce-fileapi:files:upload

Provisioning PowerShell V2 connector

Correlation configuration

The correlation configuration is used to specify which properties will be used to match an existing account within RAET-Beaufort-IAM-API-Contact-Details 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	PersonContext.Person.ExternalId
   Account correlation field	``

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.

Note

phoneNumber is not added to the fieldMapping.json because it is realy used in combination with HelloID Provisioning.

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
Client ID	The Client ID to connect with the IAM API (created when registering the App in in the Visma Developer portal).	Yes
Client Secret	The Client Secret to connect with the IAM API (created when registering the App in in the Visma Developer portal).	Yes
Tenant ID	The Tenant ID to specify to which Raet tenant to connect with the IAM API (available in the Visma Developer portal after the invitation code has been accepted).	Yes
UpdateOnUpdate	If you also want to update the user on a update account

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/