UKGPro

0.3.0

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

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

Install-PSResource -Name UKGPro

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.0 - Termination-date filter redesign (BREAKING).

Get-UKGProEmploymentDetails: -TerminatedOperator is REMOVED. The
single -TerminatedOn <date> parameter is replaced with three
intent-named parameters, each with its own natural semantic and no
operator argument required:

 -TerminatedOn <date>      terminated on that exact date (equality)
 -TerminatedSince <date>   terminated on/after that date (>)
 -TerminatedBefore <date>  terminated on/before that date (<)
 -TerminatedBetweenStart / -TerminatedBetweenEnd    range (unchanged)

Migration:
 OLD: -TerminatedOn X -TerminatedOperator GreaterThan  -> -TerminatedSince X
 OLD: -TerminatedOn X -TerminatedOperator LessThan     -> -TerminatedBefore X
 OLD: -TerminatedOn X -TerminatedOperator EqualTo      -> -TerminatedOn X (default now)
 OLD: -TerminatedOn X (no -TerminatedOperator)         -> -TerminatedSince X
   (old default was GreaterThan; the parameter name promised equality
    but the behavior returned "after that date" -- root cause of the fix)

The four termination-filter parameters are mutually exclusive via
parameter sets, so PowerShell now catches "wait, which one did I
mean?" mistakes at bind time.

v0.2.1 (previous) - Friendlier first-run errors for SecretManagement
setup: Save/Update-UKGProCredential and Connect-UKGPro -FromVault now
detect missing module / missing vault / missing default vault up
front and throw copy-pasteable setup commands.

FileList

Version History

Version Downloads Last updated
0.3.0 (current version) 5 9/2/2026
0.2.1 5 9/2/2026