https://github.com/tools4everbv/helloid-task-sa-target-helloid-groupgrantmembership
HelloID - Group grant membership
https://github.com/tools4everbv/helloid-task-sa-target-helloid-groupgrantmembership
delegated-form helloid powershell product service-automation task
Last synced: 8 months ago
JSON representation
HelloID - Group grant membership
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-task-sa-target-helloid-groupgrantmembership
- Owner: Tools4everBV
- Created: 2023-11-27T08:56:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T12:17:55.000Z (over 2 years ago)
- Last Synced: 2025-01-08T10:45:19.146Z (over 1 year ago)
- Topics: delegated-form, helloid, powershell, product, service-automation, task
- Language: PowerShell
- Homepage:
- Size: 21.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-Target-HelloID-GroupGrantMembership
## Prerequisites
- [ ] HelloID API key and secret
- [ ] Pre-defined variables: `portalBaseUrl`, `portalApiKey` and `portalApiSecret` created in your HelloID portal.
## Description
This code snippet will add an existing group to an existing group within HelloID and executes the following tasks:
1. Define a hash table `$formObject`. The keys of the hash table represent the properties necessary to add an existing group to an existing group within `HelloID`, while the values represent the values entered in the form.
> To view an example of the form output, please refer to the JSON code pasted below.
```json
{
"groupToAddGUID": "9f2c94e5a-7881-455a-a727-3fafd9d926e0",
"groupToAddName": "John Doe's group To Add",
"groupGUID": "9509133d-8ae4-48bf-a2cb-e0f31cae4deb",
"groupName": "John Doe's group"
}
```
> :exclamation: It is important to note that the names of your form fields might differ. Ensure that the `$formObject` hash table is appropriately adjusted to match your form fields.
> [See the HelloID API Docs page](https://apidocs.helloid.com/docs/helloid/7ae11d9ebccc2-link-a-group-to-a-group)
2. Creates authorization headers using the provided API key and secret.
3. add an existing group to an existing group using the: `Invoke-RestMethod` cmdlet. The hash table called: `$formObject` is passed to the body of the: `Invoke-RestMethod` cmdlet as a JSON object.