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-kpn-bart

KPN Bart - Target
https://github.com/tools4everbv/helloid-conn-prov-target-kpn-bart

kpn pnc provisioning target

Last synced: about 1 month ago
JSON representation

KPN Bart - Target

Awesome Lists containing this project

README 

        
# HelloID-Conn-Prov-Target-KPN-Bart



| :information_source: Information |

|:---------------------------|

| 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

- [Introduction](#Introduction)

- [Getting started](#Getting-started)

  - [Prerequisites](#Prerequisites)

  - [Connection settings](#Connection-settings)

  - [PSModule](#PSModule)

  - [DLL](#DLL)

  - [Contents](#Contents)

  - [Remarks](#Remarks)

- [Setup the connector](#Setup-the-connector)

- [Getting help](#Getting-help)

- [HelloID Docs](#HelloID-Docs)



## Introduction



The *HID-Conn-Prov-Target-KPN-Bart* needs to be **executed on-premises**. Make sure you have **Windows PowerShell 5.1** installed on the server where the **HelloID agent and provisioning** agent are running, and that the *Execute on-premises* switch is toggled on the connector system tab within HelloID.



- creates, modifies, enables, disables, and deletes accounts in bart

- updates account attributes, user passwords, primary email and aliases.

- set user types or persona types when creating or modifing accounts

- grant/revoke memberschip of groups and functiongroups.



## Getting started



### Prerequisites



- [ ] KPN Bart PowerShell module



  The KPN Bart PowerShell module must be installed locally. The module can be downloaded directly from the Github repository. Make sure you unblock the DLL in Windows.



- [ ] Windows PowerShell 5.1



  Windows PowerShell 5.1 must be installed on the server where the 'HelloID agent and provisioning agent' are running.



  > The connector is not compatible with older versions of Windows PowerShell or PowerShell Core.



### Connection settings



| Setting                         | Description                                                  | Example                                                      |

| ------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |

| Bart service URL                | Example:The url to the bart service endpoint to connect to   | https://.bartws.local                   |

| Username                        | The user name of the account with wich the HelloID provisioning agent connects to bart to perform all operations. | APP\Tools4eve_PE   (See remark)                          |

| Password                        | Password of the above connection account                     |                                                              |

| Full path to KPN-Bart Powershel | The full path to the module *.psd1 file                      | D:\data\HelloID-Conn-Prov-Target-KPN-Bart\KPNBart\KPNBart.psd1 |

| Default AD Domain               | The default domain in which to create new bart accounts.     | Mydomain.local                                             |



Remark: The username should be in the DOMAIN\samaccountname format. (For example: APP\Tools4eve_PE). If the password is incorrect, you will recieve the error message:  ""The HTTP request is unauthorized with client authentication scheme 'Negotiate'. The authentication header received from the server was 'Negotiate,NTLM'.""



### PSModule



The connector uses a PowerShell module that must be installed locally. Make sure the entire 'KPNBart' folder, that contains the module, is copied to a directory accessible by the helloid agent.



In the configuration parameters of the target system in helloid, you must specify the full path to the module definition file (KPNBart.psd1), so the HelloId agent can load the module.



#### Available functions



To get a list of all available functions within the module: 'Get-Command -Module KPNBart'.



#### Module help



All functions in the PSKPNBart module have comment based help. To get help for a specific function: 'Get-Help -Command New-KpNBartUser'.



### DLL



The KPN Bart PSModule uses an additional *.DLL (KPNbart/bin/KPNBartConnectedServices.dll) that includes the WSDL. Reason for this is that certain methods (to connect to KPN Bart using specific HTTP bindings) were not available when the WSDL's were loaded directly into PowerShell using the:  cmdlet. The C# connector uses these HTTP bindings. Since this is a copy of the C# connector, those bindings are copied.



*Note* make sure to check that this file is not "blocked" by windows when copying from the internet and "unblock" this file in windows if this is the case.



The easiest way to do this is by using PowerShell from the directory in which the files are downloaded.



```powershell

  Get-ChildItem | Unblock-File

```



## contents



| File/Directory                | Description                                                  |

| ----------------------------- | ------------------------------------------------------------ |

| Subdirectory kpnBart          | This contains the Powershell module used by the other files. |

| create.ps1                    | Creates a new user in bart, inclusive attributes, passwords, persona, and email etc.
It uses the UPN as target account identifier. When a user does already exist, it correlates the person with the account and, and updates the account. |

| update.ps1                    | updates an existing account.                                 |

| enable.ps1                    | enables an existing account.                                 |

| disable.ps1                   | disables an existing account.                                |

| delete.ps1                    | deletes an existing account.                                 |

| entitlementsGroups.ps1        | Collects a list of function groups. and can be used for entitlements in a "retrieve permissions" script. |

| entitlementsFunctionGroup.ps1 | Can be user for entitlements in a "retrieve permissions" script. |

| grantPermissionsGroup.ps1     | Grants a permission to a user for a resource and can be used in a grand permission script, for any type of resource. |

| revokePermissionsGroup.ps1    | Revokes a permission from a user for a resource and can be user in a revoke permissing script, for any type of resource. |



## Remarks



### The create process constist of 3 phases

- creation of a "base" account with the following fields:  FirstName,LastName,Initials,Password,UserPrincipalName,DisplayName,MiddleName, SamAccountName



- The extention of the account with direct AD attributes



- Special calls to update more complex properties (like mail addresses, password reset on next logon, etc)

  

> When a user UPN is already used, the  base user is correlated, instead of created, but the enrichment of the account in phase 2 and 3 proceeds as normal. So the fields listed in phase 1 are not updated for existing users on a create.



> When a user is created, but the supplied SamAccountName does violate a Bart naming convention, the create action will fail with an exception, but Bart may still create the base account, with an automatically generated SamAccountName. In such case, retrying the create in helloid will successfully create the account, but with the automated SamAccountName



> The grant and revoke permissions scripts work for any type of resource. Therefore there are no different files for different types resources. The grant/revoke files for the groups can be used directly for other resources also.



## Getting help



> _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/hc/en-us/articles/360012557600-Configure-a-custom-PowerShell-source-system) pages_



> _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/