{"id":19504374,"url":"https://github.com/tools4everbv/helloid-conn-prov-target-ntfs-folder","last_synced_at":"2025-07-19T03:03:44.769Z","repository":{"id":113210687,"uuid":"502947041","full_name":"Tools4everBV/HelloID-Conn-Prov-Target-NTFS-Folder","owner":"Tools4everBV","description":"NTFS - Target","archived":false,"fork":false,"pushed_at":"2024-12-12T13:47:08.000Z","size":117,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-04T01:47:48.064Z","etag":null,"topics":["acl","dfm","directory","folder","home","homefolder","icacls","ntfs","profile","profilefolder","provisioning","set-acl","tshome","tsprofile"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tools4everBV.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-13T12:28:59.000Z","updated_at":"2024-12-12T12:48:51.000Z","dependencies_parsed_at":"2024-01-15T15:48:02.746Z","dependency_job_id":"c4474d93-7473-437e-bdc7-04813b2ecf6a","html_url":"https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-NTFS-Folder","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Tools4everBV/HelloID-Conn-Prov-Target-NTFS-Folder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-NTFS-Folder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-NTFS-Folder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-NTFS-Folder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-NTFS-Folder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tools4everBV","download_url":"https://codeload.github.com/Tools4everBV/HelloID-Conn-Prov-Target-NTFS-Folder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tools4everBV%2FHelloID-Conn-Prov-Target-NTFS-Folder/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265878910,"owners_count":23843032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acl","dfm","directory","folder","home","homefolder","icacls","ntfs","profile","profilefolder","provisioning","set-acl","tshome","tsprofile"],"created_at":"2024-11-10T22:25:30.938Z","updated_at":"2025-07-19T03:03:44.738Z","avatar_url":"https://github.com/Tools4everBV.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HelloID-Conn-Prov-Target-NTFS\n\n\u003e [!IMPORTANT]\n\u003e 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.\n\n\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://www.tools4ever.nl/connector-logos/ntfs-logo.png\" width=\"500\"\u003e\n\u003c/p\u003e\n\n## Table of contents\n\n- [HelloID-Conn-Prov-Target-NTFS](#helloid-conn-prov-target-ntfs)\n - [Table of contents](#table-of-contents)\n - [Introduction](#introduction)\n - [Getting started](#getting-started)\n - [Provisioning PowerShell V2 connector](#provisioning-powershell-v2-connector)\n - [Correlation configuration](#correlation-configuration)\n - [Field mapping](#field-mapping)\n - [Prerequisites](#prerequisites)\n - [Remarks](#remarks)\n - [Getting help](#getting-help)\n - [HelloID docs](#helloid-docs)\n\n## Introduction\n\n_HelloID-Conn-Prov-Target-NTFS-Folder is a \\_target_ connector that allows you to manage the NTFS folders and permissions.\nIf you need to adjust the permissions on the folders **created by the HelloID built-in AD connector (Home, TsHome, Profile or TsProfile)**, the Post AD action script can be used.\nFor creating or managing **folders not created by HelloID**, the GrantPermission and RevokePermission scripts can be used.\n\nThe following lifecycle actions are available:\n\n| Action | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| correlateonly/create.ps1 | PowerShell _create_ lifecycle action |\n| permissions/HomeFolder/grantPermission.ps1 | PowerShell _grant_ lifecycle action |\n| permissions/HomeFolder/revokePermission.ps1 | PowerShell _revoke_ lifecycle action |\n| permissions/HomeFolder/permissions.ps1 | PowerShell _permissions_ lifecycle action |\n| configuration.json | Default _configuration.json_ |\n| correlateonly/fieldMapping.json | Default _fieldMapping.json_ |\n| postAdAction/postAdAction.create.SetDirectoryPermissions.Set-ACL | Set permissions to the **already created** NTFS folder using the command [Set-ACL](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-acl?view=powershell-7.2) used in the **Create** [Post Action](https://docs.helloid.com/hc/en-us/articles/360012421460-Configure-the-on-premises-Microsoft-Active-Directory-target-system#2.4.2:~:text=Post%20Action%20Configuration) of the [built-in Microsoft Active Directory Target Connector](https://docs.helloid.com/hc/en-us/articles/360012421460-Configure-the-on-premises-Microsoft-Active-Directory-target-system) |\n| postAdAction/postAdAction.create.SetDirectoryPermissions.icacls | Set permissions to the **already created** NTFS folder using the command [ICACLS](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/icacls) used in the **Create** [Post Action](https://docs.helloid.com/hc/en-us/articles/360012421460-Configure-the-on-premises-Microsoft-Active-Directory-target-system#2.4.2:~:text=Post%20Action%20Configuration) of the [built-in Microsoft Active Directory Target Connector](https://docs.helloid.com/hc/en-us/articles/360012421460-Configure-the-on-premises-Microsoft-Active-Directory-target-system) |\n\n## Getting started\n\n### Provisioning PowerShell V2 connector\n\n#### Correlation configuration\n\nThe correlation configuration is used to specify which properties will be used to match an existing account within _NTFS_ to a person in _HelloID_.\n\nTo properly setup the correlation:\n\n1. Open the `Correlation` tab.\n\n2. Specify the following configuration:\n\n | Setting | Value |\n | ------------------------- | --------------------------------- |\n | Enable correlation | `True` |\n | Person correlation field | `PersonContext.Person.ExternalId` |\n | Account correlation field | `employeeId` |\n\n\u003e [!TIP] \n\u003e _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_.\n\n#### Field mapping\n\nThe field mapping can be imported by using the _fieldMapping.json_ file.\n\n### Prerequisites\n\n- The HelloID Service account requires the following permissions:\n - Local admin on the fileshare/ntfs server.\n - Full Control on the share itself ([Share permissions](https://docs.microsoft.com/en-us/iis/web-hosting/configuring-servers-in-the-windows-web-platform/configuring-share-and-ntfs-permissions#:~:text=To%20configure%20permissions%20for%20the%20share), not NTFS permissions on the folder(s)).\n - Full Control on all folders on the share ([NTFS permissions](https://docs.microsoft.com/en-us/iis/web-hosting/configuring-servers-in-the-windows-web-platform/configuring-share-and-ntfs-permissions#:~:text=To%20configure%20permissions%20for%20the%20folder%20structuree), so not Share permissions on the Share).\n - Optionally, the following policies:\n - Local Policies \u003e User Rights Assignment \u003e Manage auditing and security log\n - Local Policies \u003e User Rights Assignment \u003e Back up files and directories\n - Local Policies \u003e User Rights Assignment \u003e Restore files and directories\n\n### Remarks\n\n\u003e [!IMPORTANT]\n\u003e The revoke scripts use the stored account data if the AD account is removed before archiving the folder. The default target connector name `NTFS` is used. Please change the name on rows `54` and `55` if you use a different target connector name.\n\n## Getting help\n\n\u003e [!TIP] \n\u003e _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/hc/en-us/articles/360012558020-Configure-a-custom-PowerShell-target-system) pages_\n\n\u003e [!TIP] \n\u003e _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_\n\n## HelloID docs\n\nThe official HelloID documentation can be found at: https://docs.helloid.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftools4everbv%2Fhelloid-conn-prov-target-ntfs-folder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftools4everbv%2Fhelloid-conn-prov-target-ntfs-folder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftools4everbv%2Fhelloid-conn-prov-target-ntfs-folder/lists"}