PRO WFM Authentication (Preview)
Simplifies the steps to retrieve and manage an access token for UKG Pro WFM APIs.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | KGS |
| URL | https://www.ukg.com/support |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Charu Ramachandran |
| Website | https://www.ukg.com/ |
| Privacy policy | https://www.ukg.com/privacy |
| Categories | Human Resources |
UKG PRO WFM Authentication Connector
Uses the UKG Pro Workforce Management (WFM) authentication API to generate an OAuth 2.0 access token, enabling secure and authenticated communication with UKG Pro WFM APIs. This ensures proper authorization for accessing workforce data and functionality. The connector simplifies authentication, supports seamless integration, and allows organizations to build custom solutions, automate workflows, and securely interact with workforce-related data while adhering to industry standards.
Publisher: Ultimate Kronos Group
Prerequisites
The following are required to use this connector:
An existing account for your organization along with an employee with the appropriate Developer Admin permissions to generate an app key. Refer to the Authentication topic for more information (https://developer.ukg.com/wfm/docs/authentication-and-security-doc).
Supported Operations
The connector supports the following operations:
Get Access Token
Exchanges credentials for an OAuth access token which is needed to call UKG Pro WFM APIs.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get an OAuth access token |
Credentials for an OAuth access token which is needed to call UKG Pro WFM APIs. |
Get an OAuth access token
Credentials for an OAuth access token which is needed to call UKG Pro WFM APIs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The Pro WFM Vanity URL
|
vanityURL | True | string |
The Pro WFM Vanity URL you use to access Pro WMF (for non SSO use cases). |
|
username
|
username | True | string |
The runtime user's username for accessing Pro WFM. |
|
password
|
password | True | password |
The runtime user's password for accessing Pro WFM. |
|
client_id
|
client_id | True | string |
The oAuth client ID assigned to this Pro WFM tenant. |
|
client_secret
|
client_secret | True | string |
The oAuth client secret assigned to this Pro WFM tenant. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
access_token
|
access_token | string |
The access token created for accessing Pro WFM APIs. |
|
refresh_token
|
refresh_token | string |
The refresh token to get a new access token when the access token expires. |
|
scope
|
scope | string |
The scope assigned to the access token. |
|
id_token
|
id_token | string |
The id token associated with the access token. |
|
token_type
|
token_type | string |
The type of token. |
|
expires_in
|
expires_in | integer |
The time until the access token expires. |