ServiceDeskPlusCloud

PowerShell module focused on manipulating the ServiceDeskPlus OnDemand (cloud) API.

Getting Started

In order to obtain a temporary authorization code to authenticate to the API with, you first need to register a self-client application via the ZOHO API Client Console. See the ManageEngine API documentation for the full documentation on registration.

Follow the steps in the documentation to generate a temporary authentication code and supply the value to the GrantToken parameter of New-ZohoAccessToken or download the self_client.json file from the API client console and supply the path via the FilePath parameter.

$NewTokenParams = @{
  GrantToken = '1000.f74e7b6fc16c95bbc1fa2f067962f84b.9768e796b6273774817032613ba6892a'
  ClientId = '1000.15S25B602CISR5WO9RUZ8UT39O3RIH'
  ClientSecret = '9ea302935eb150d9d6cbefd35b1eb8891332d815b8'
}

$ZohoAuth = New-ZohoAccessToken @NewTokenParams

Request and store the access token in the local secret store:

Request-ZohoAccessToken -Verbose

Module functions will retrieve the access token from the store as needed, so it doesn't need to be specified:

$RequestParams = @{
    Status = 'Open', 'Onhold'
    Portal = 'is'
    Technician = 'devynspencer@users.noreply.github.com'
}

$Tickets = Find-ServiceDeskRequest @RequestParams

Default Parameters

PowerShell allows you to save default values for parameters via the PSDefaultParameterValues variable.

Add defaults to your PowerShell profile to limit the number of parameters that need to be specified when executing ServiceDeskPlusCloud functions:

# Microsoft.PowerShell_Profile.ps1

$PSDefaultParameterValues['*-ServiceDeskPlus*:Portal'] = 'is'
$PSDefaultParameterValues['Find-ServiceDeskPlusRequest:Technician'] = 'devynspencer@users.noreply.github.com'

Testing

First install the Pester module:

Install-Module Pester -Force

You're ready to run Pester tests:

Invoke-Pester

Environment Variables

Some parts of this module assume the use of environment variables for the storage of sensitive "secrets" like account names or API tokens.

Specifically, be sure to either set the following environment variables or update the configurations accordingly:

Builder

• BUILDER_STAGING_REPOSITORY_PATH: Filesystem path to use as the source for the local staging PSRepository.

• BUILDER_ORG_REGISTRY_SOURCE_URI: URI of service index on internal NuGet server.

• BUILDER_ORG_REGISTRY_PUBLISH_URI: URI of publish endpoint on internal NuGet server.

• BUILDER_ORG_REGISTRY_SEARCH_URI: URI of search endpoint on internal NuGet server. Used for querying packages in debug tasks.

• BUILDER_ORG_REGISTRY_API_KEY: API token used for publishing packages to internal NuGet server.