UKGPro

0.3.2

General-purpose PowerShell wrapper for the UKG Pro HCM REST API. Provides Get- cmdlets for personnel/v1 (employment, person) and configuration/v1 (org-levels, jobs, job-groups, company-details) endpoints with unified authentication, pagination, date-filter handling, secure-by-default PII redaction, and optional SecretManagement-backed auth.

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name UKGPro -RequiredVersion 0.3.2

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name UKGPro -Version 0.3.2

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) Super Core Solutions LLC. All rights reserved.

Package Details

Author(s)

  • Don Sheehan

Tags

UKG UKGPro HCM Personnel Employee REST IAM HR SecretManagement

Functions

Connect-UKGPro Disconnect-UKGPro Save-UKGProCredential Update-UKGProCredential Get-UKGProEmploymentDetails Get-UKGProPersonDetails Get-UKGProOrgLevel Get-UKGProJobGroup Get-UKGProJob Get-UKGProCompanyDetails

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

v0.3.2 - Compact default table view for Get-UKGProEmploymentDetails.

Records returned by Get-UKGProEmploymentDetails now render as a
four-column table by default (EmployeeId, CompanyId, JobTitle,
Status) -- much easier to scan when a query returns multiple
employees (e.g. the -EmailAddress fan-out from v0.3.1 or any list
query). Every property is still on the object; `| Format-List` shows
them all, same convention as Get-Mailbox in Exchange.

Implementation: new UKGPro.format.ps1xml + records tagged with the
UKGPro.EmploymentDetails TypeName. No cmdlet signature changes; no
property changes; existing scripts that access properties by name are
unaffected. Scripts that captured Out-String output would see
different formatted text.

v0.3.1 (previous) - Get-UKGProEmploymentDetails -EmailAddress now
fans out on multi-match instead of throwing. If person-details returns
multiple distinct employees for the supplied email, records for all
of them are returned rather than a "use -EmployeeId to disambiguate"
error.

v0.3.0 (previous) - Termination-date filter redesign (BREAKING).
Get-UKGProEmploymentDetails: -TerminatedOperator removed. Replaced by
four mutually-exclusive intent-named params: -TerminatedOn (equality),
-TerminatedSince (>), -TerminatedBefore (<), and the existing
-TerminatedBetweenStart/-End range.

FileList

Version History

Version Downloads Last updated
0.3.3 3 9/8/2026
0.3.2 (current version) 4 9/8/2026
0.3.0 8 9/2/2026
0.2.1 6 9/2/2026