- TOPdesk API Username and Key
- User-defined variables:
topdeskBaseUrl
,topdeskApiUsername
andtopdeskApiSecret
created in your HelloID portal.
This code snippet will update an existing person within TOPdesk and executes the following tasks:
- Define a hash table
$formObject
. The keys of the hash table represent the properties necessary to update an existing person withinTOPdesk
, 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.
{
"id": "634206ca-6907-4914-8509-da55cfd8b35d",
"surName": "Doe",
"prefixes": "van der",
"firstName": "John",
"firstInitials": "J.J.",
"gender": "MALE",
"telephone": "0229123456",
"mobileNumber": "0612345678",
"employeeNumber": "12345678",
"email": "j.doe@enyoi.org",
"networkLoginName": "j.doe",
"loginName": "j.doe@enyoi.org",
"jobTitle": "Tester",
"branch": {
"id": "1fe19024-d652-46ec-b080-eec3737a3d7a"
},
"department": {
"id": "54a543bc-e8a3-425d-9c44-065b862b313e"
},
"loginPermission": true
}
❗ 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 TOPdesk API Docs page
-
Creates authorization headers using the provided API key and secret.
-
Update an existing person using the:
Invoke-RestMethod
cmdlet. The hash table called:$formObject
is passed to the body of the:Invoke-RestMethod
cmdlet as a JSON object.