- HelloID API key and secret
- Pre-defined variables:
portalBaseUrl
,portalApiKey
andportalApiSecret
created in your HelloID portal.
This code snippet will update an existing user within HelloID and executes the following tasks:
- Define a hash table
$formObject
. The keys of the hash table represent the properties necessary to update an existing user withinHelloID
, 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.
{
"userName": "john.doe",
"firstName": "john",
"lastName": "doe",
"contactEmail": "johndoe@enyoi.org",
"isEnabled": "true",
"password": "P@ssw0rd1!",
"mustChangePassword": "true",
"employeeid": "12345678",
"title": "tester",
"department": "test",
"phonenumber": "0612345678",
"manager": {
"UserGUID": "8a6b62fc-dca3-4890-bacd-3db76c5e9152"
}
}
Note: the 'userName' property serves as the identifier, indicating which user is being updated.
❗ 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
-
Creates authorization headers using the provided API key and secret.
-
Update an existing using the:
Invoke-RestMethod
cmdlet. The hash table called:$formObject
is passed to the body of the:Invoke-RestMethod
cmdlet as a JSON object.