/HelloID-Task-SA-Target-TOPdesk-OperatorCreate

TOPdesk - Operator create

Primary LanguagePowerShell

HelloID-Task-SA-Target-TOPdesk-OperatorCreate

Prerequisites

  • TOPdesk API Username and Key
  • User-defined variables: topdeskBaseUrl, topdeskApiUsername and topdeskApiSecret created in your HelloID portal.

Description

This code snippet will create a new 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 create a new 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.

{
    "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

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

  2. Create a new 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.