HelloID-Task-SA-Target-HelloID-GroupRevokeMembership

Prerequisites

• HelloID API key and secret
• Pre-defined variables: portalBaseUrl, portalApiKey and portalApiSecret created in your HelloID portal.

Description

This code snippet will remove an existing group from 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 remove an existing group from 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.

{
    "groupToRemoveGUID": "9f2c94e5a-7881-455a-a727-3fafd9d926e0",
    "groupToRemoveName": "John Doe's group To Remove",
    "groupGUID": "9509133d-8ae4-48bf-a2cb-e0f31cae4deb",
    "groupName": "John Doe's group"
}

❗ 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

2. Creates authorization headers using the provided API key and secret.

3. remove an existing group from 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.