https://github.com/tools4everbv/helloid-task-sa-target-topdesk-operatorupdate
TOPdesk - Operator update
https://github.com/tools4everbv/helloid-task-sa-target-topdesk-operatorupdate
delegated-form powershell product service-automation task topdesk
Last synced: over 1 year ago
JSON representation
TOPdesk - Operator update
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-task-sa-target-topdesk-operatorupdate
- Owner: Tools4everBV
- Created: 2023-12-08T17:29:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T10:52:56.000Z (over 2 years ago)
- Last Synced: 2025-01-08T10:45:11.393Z (over 1 year ago)
- Topics: delegated-form, powershell, product, service-automation, task, topdesk
- Language: PowerShell
- Homepage:
- Size: 41 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-TOPdesk-OperatorUpdate
## Prerequisites
- [ ] TOPdesk API Username and Key
- [ ] User-defined variables: `topdeskBaseUrl`, `topdeskApiUsername` and `topdeskApiSecret` created in your HelloID portal.
## Description
This code snippet will update an existing operator within TOPdesk and executes the following tasks:
1. Define a hash table `$formObject`. The keys of the hash table represent the properties necessary to update an existing operator within `TOPdesk`, 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
{
"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
}
```
> :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 TOPdesk API Docs page](https://developers.topdesk.com/explorer/?page=supporting-files#/Operators/patchOperatorById)
2. Creates authorization headers using the provided API key and secret.
3. Update an existing operator using the: `Invoke-RestMethod` cmdlet. The hash table called: `$formObject` is passed to the body of the: `Invoke-RestMethod` cmdlet as a JSON object.