https://github.com/tools4everbv/helloid-task-sa-target-activedirectory-accountdisable
Active Directory - User account disable
https://github.com/tools4everbv/helloid-task-sa-target-activedirectory-accountdisable
active-directory delegated-form powershell product service-automation task
Last synced: 27 days ago
JSON representation
Active Directory - User account disable
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-task-sa-target-activedirectory-accountdisable
- Owner: Tools4everBV
- Created: 2023-02-23T14:29:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-09T15:13:27.000Z (over 2 years ago)
- Last Synced: 2025-01-08T10:45:41.329Z (over 1 year ago)
- Topics: active-directory, delegated-form, powershell, product, service-automation, task
- Language: PowerShell
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# HelloID-Task-SA-Target-ActiveDirectory-AccountDisable
## Prerequisites
- [ ] The HelloID SA on-premises agent installed
- [ ] The ActiveDirectory module is installed on the server where the HelloID SA on-premises agent is running.
## Description
This code snippet will disable a user within Active Directory and executes the following tasks:
1. Define a hash table `$formObject`. The keys of the hash table represent the properties of the `Get-ADUser` cmdlet, while the values represent the values entered in the form.
> To view an example of a form output, please refer to the JSON code pasted below.
```json
{
"UserPrincipalName": "testuser@mydomain.local"
}
```
> :exclamation: It is important to note that the names of your form fields might differ. Ensure that the `$formObject` hashtable is appropriately adjusted to match your form fields. [See the Microsoft Docs page](https://learn.microsoft.com/en-us/powershell/module/activedirectory/disable-adaccount?view=windowsserver2022-ps)
2. Imports the ActiveDirectory module.
3. Verifies that the account that must be disabled exists based on the `userPrincipalName` using the `Get-ADUser` cmdlet.
4. If the user does exist, the account is disabled using the `Disable-ADUser` cmdlet, otherwise an error is generated.