UKGPro

0.2.1

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.2.1

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

Install-PSResource -Name UKGPro -Version 0.2.1

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.2.1 - Better first-run errors for SecretManagement setup.

Save-UKGProCredential / Update-UKGProCredential / Connect-UKGPro
-FromVault now detect three fresh-machine failure modes up front and
throw copy-pasteable setup commands instead of surfacing the raw
"no vault provided and there is no default vault designated" error
from Set-Secret:
 1. Microsoft.PowerShell.SecretManagement not installed.
 2. Module installed but no vault registered (Install-Module
    SecretStore + Register-SecretVault -DefaultVault).
 3. Vaults registered but none marked default (Set-SecretVaultDefault
    or supply -VaultName).

No cmdlet signatures changed. No breaking changes.

v0.2.0 (previous) - Expanded read surface + auth ergonomics + secure
PII defaults. Cmdlets: Connect-UKGPro (Explicit / -FromVault /
-FromEnvironment), Disconnect-UKGPro, Save-UKGProCredential,
Update-UKGProCredential (hostname + tenant API keys only --
username/password are never persisted in the vault by design),
Get-UKGProEmploymentDetails, Get-UKGProPersonDetails
(secure-by-default PII redaction, opt in with -IncludePII),
Get-UKGProOrgLevel, Get-UKGProJobGroup, Get-UKGProJob (v2 endpoints),
Get-UKGProCompanyDetails. Unified auth (Basic + US-Customer-API-Key +
x-api-key), automatic page/per_Page pagination, friendly date filters
for UKG's operator-prefixed date syntax. Every Get- cmdlet works with
a View-only UKG service account.

FileList

Version History

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