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 |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
| 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) |
| 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 |
PRO WFM authentication connector simplifies the steps to retrieve and manage an access token for PRO WFM APIs.
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 App keys, client ID, and client secret topic for more information (https://developer.ukg.com/wfm/docs/app-keys-client-id-and-client-secret-doc).
How to get credentials
Configure the connector properties using the prerequisite information during the connection creation process. Upon a successful call, the connector's response will include both the access token and refresh token. These tokens can be subsequently utilized as parameters in other PRO WFM connectors to facilitate interaction with PRO WFM APIs.
Get started with your connector
- Select
Get Access Tokenfrom the list of actions.
Known issues and limitations
None
Common errors and remedies
Contact us via https://www.ukg.com/support
FAQ
Contact us via https://www.ukg.com/support in case of errors and questions.
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. |