https://github.com/tools4everbv/helloid-task-sa-source-helloid-accountsearch
HelloID - User account search
https://github.com/tools4everbv/helloid-task-sa-source-helloid-accountsearch
data-source helloid powershell service-automation
Last synced: 7 months ago
JSON representation
HelloID - User account search
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-task-sa-source-helloid-accountsearch
- Owner: Tools4everBV
- Created: 2024-06-17T09:52:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T10:28:50.000Z (almost 2 years ago)
- Last Synced: 2025-01-08T10:44:56.600Z (about 1 year ago)
- Topics: data-source, helloid, powershell, service-automation
- Language: PowerShell
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HelloID-Task-SA-Source-HelloID-AccountSearch
## Prerequisites
- [ ] _HelloID_ environment.
- [ ] _HelloID_ Service Automation agent (cloud or on-prem).
- [ ] Access to the _HelloID_ API.
- [ ] API Key
- [ ] API Secret
## Description
This code snippet executes the following tasks:
1. Imports the ActiveDirectory module.
2. Define a search query `$HelloIDUserSearchFilter` based on the search parameter `$datasource.searchUser`
3. Retrieve the HelloID users using the `Get all users` API with a paging of 1000.
> The query property **search** searches for users via contains in following fields: Firstname, Lastname, Username, Contact email [See the HelloID Docs page](https://apidocs.helloid.com/docs/helloid/041932dd2ca73-get-all-users)
1. Return a hash table for each user account using the `Write-Output` cmdlet.
> To view an example of the data source output, please refer to the JSON code pasted below.
```json
{
"searchUser": "James"
}
```