UKGPro

1.0.0

PowerShell module for the UKG Pro HCM REST API, focused on read-only IAM/offboarding automation. Provides Get- cmdlets for employment, person, org-level, job, job-group, company-details, and location lookups 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 Get-UKGProLocation

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

v1.0.0 - First stable release. The public API surface (11 exported
cmdlets, parameter shapes, output types, compact-view formatting) is
committed: any future breaking change bumps to 2.0. Also in this
release: new Get-UKGProLocation cmdlet wrapping
/configuration/v1/locations (list + unique lookup by -Code, with
-CountryCode / -IsActive filters; compact view: LocationCode,
Description, City, IsActive). Manifest description also tightened to
accurately reflect scope (read-only IAM/offboarding-focused Get-
surface) rather than "general-purpose UKG Pro HCM wrapper".

v0.3.3 (previous) - Compact default table views extended to the remaining
Get- cmdlets (Get-UKGProPersonDetails, Get-UKGProOrgLevel,
Get-UKGProJobGroup, Get-UKGProJob, Get-UKGProCompanyDetails), so
every Get- cmdlet in the module now shares the same Get-Mailbox-style
output convention introduced for Get-UKGProEmploymentDetails in
v0.3.2. Column choices:

 PersonDetails    : EmployeeId, FirstName, LastName, EmailAddress
 OrgLevel         : Level, Code, Description, IsActive
 JobGroup         : JobGroupCode, Description, CountryCode
 Job              : JobCode, Title, CountryCode, IsActive
 CompanyDetails   : CompanyId, CompanyCode, MasterCompanyId, IsMaster

Also factored the tagging into a shared private Add-UKGProTypeName
helper (Get-UKGProEmploymentDetails swapped from its inline
ForEach-Object to use it, for consistency). No cmdlet signature or
property changes.

v0.3.2 (previous) - Compact default table view for
Get-UKGProEmploymentDetails (EmployeeId, CompanyId, JobTitle, Status).
Every property still on the object; `| Format-List` shows them all,
matching the Get-Mailbox convention in Exchange PowerShell.
Introduced UKGPro.format.ps1xml + FormatsToProcess in the manifest.

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
1.0.0 (current version) 9 9/29/2026
0.3.3 15 9/8/2026
0.3.2 5 9/8/2026
0.3.0 12 9/2/2026
0.2.1 8 9/2/2026