Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tools4everbv/helloid-conn-prov-target-activedirectory

Active Directory - Target
https://github.com/tools4everbv/helloid-conn-prov-target-activedirectory

active-directory dir dynamic dynamic-permissions dynamicpermissions itm permissions provisioning target

Last synced: 2 months ago
JSON representation

Active Directory - Target

Awesome Lists containing this project

README

        

# HelloID-Conn-Prov-Target-ActiveDirectory

> [!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-ActiveDirectory](#helloid-conn-prov-target-activedirectory)
- [Table of contents](#table-of-contents)
- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Provisioning PowerShell V2 connector](#provisioning-powershell-v2-connector)
- [Correlation configuration](#correlation-configuration)
- [Field mapping](#field-mapping)
- [Connection settings](#connection-settings)
- [Prerequisites](#prerequisites)
- [Getting help](#getting-help)
- [HelloID docs](#helloid-docs)

## Introduction

_HelloID-Conn-Prov-Target-ActiveDirectory_ is a _target_ connector. This connector is used to dynamically add Active Directory groups to Active Directory users by assigning subPermissions within HelloID.

The following lifecycle actions are available:

| Action | Description |
| ------------------------------------- | ------------------------------------------------------------------------ |
| create.ps1 | PowerShell _create_ lifecycle action. This action correlates the account |
| permissions/groups/subPermissions.ps1 | PowerShell _subPermissions_ lifecycle action |
| resources/groups/resources.ps1 | PowerShell _resources_ lifecycle action |
| configuration.json | Default _configuration.json_ |
| fieldMapping.json | Default _fieldMapping.json_ |

## Getting started

### Provisioning PowerShell V2 connector

#### Correlation configuration

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

Please rename the field mapping correlation field to the correlation field used in the dependent system.
Most likely the built-in Microsoft Active Directory target system.

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 | `employeeId` |

> [!TIP]
> _For more information on correlation, please refer to our correlation [documentation](https://docs.helloid.com/en/provisioning/target-systems/powershell-v2-target-systems/correlation.html) pages_.

#### Field mapping

The field mapping can be imported by using the [_fieldMapping.json_](./fieldMapping.json) file.

### Connection settings

The following settings can be configured.

| Setting | Description | Mandatory |
| ----------------------- | ------------------------------------------------------------------------------- | --------- |
| Fixed domain controller | Optionally fill in a domain controller if a fixed domain controller is required | |
| Debug | Creates extra logging for debug purposes | |

### Prerequisites
The powershell ActiveDirectory module is required for this target connector.

## Getting help

> [!TIP]
> _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/en/provisioning/target-systems/powershell-v2-target-systems.html) pages_.

> [!TIP]
> _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_.

## HelloID docs

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