HaloAPI - A PowerShell module for Halo Service Solutions software¶
Installing¶
This module is published to the PowerShell Gallery and can be installed from within PowerShell with Install-Module
1 |
|
Getting Started¶
The first and probably most important requirement for this module is getting it connected to your Halo instance.
Creating an API application in Halo¶
-
In your Halo instance head to Configuration > Integrations > Halo PSA API
This might be Halo Service Desk API or Halo ITSM API. -
Click on View Applications
All going well you should be atconfig/integrations/api/applications
. -
Click on New to add a new API application.
-
Enter the Application Name.
For example HaloAPI PS Module. -
Make sure Active is checked.
-
Set the Authentication Method to Client ID and Secret (Services).
-
Store the Client ID and Client Secret securely.
-
Set the Login Type and Agent to login as appropriately.
This setting will determine who appears to be responsible for these API calls. You may want to create a dedicated agent user for this purpose. -
Select the Permissions tab.
-
Grant the application the permissions required for your purposes.
Generally speaking you want to limit the API to only the permissions it needs to do the job you're scripting for.