Introduction

HelloID provides some PowerShell cmdlets that let your custom PowerShell scripts perform actions specific to your HelloID environment. The cmdlets and their usage will be detailed in this article. 

Hid-Write-Status

Writes information to the current task's progress log.

Example

Hid-Write-Status -Message "This will be the message" -Event Information

Parameters

• Message
The text to be written to the task's progress log.
• Event
The class of event that you are logging. These have no effect on the task's functionality, and can be chosen at your discretion. Their purpose is to let you filter logged events by severity. Acceptable values are:
  • Information
  • Success
  • Warning
  • Error
  • Failed
  • Critical

Hid-Write-Summary

Writes information to the task's summary log.

Example

Hid-Write-Summary -Message "This will be the message" -Event Information -Icon fa-tasks

Parameters

• Message
Same as Hid-Write-Status.
• Event
Same as Hid-Write-Status.
• Icon
The Font Awesome icon displayed next to the message in the summary log.

Hid-Add-TaskResult

Adds a PowerShell object to an array, which can be passed as output for use elsewhere in HelloID, such as in a data source.

Example

$result_object = @{givenName = "Bob"; familyName = "Johnson"; title = "Engineer";}
Hid-Add-TaskResult -ResultValue $result_object

Parameters

• ResultValue
The object to be added to the output array.