Basic Authentication

This topic provides the details of the required permissions for the Basic Authentication Type.

Creating a Web Service Account

UKG Pro APIs using Basic Authentication are only accessible with a web service account. UKG Pro users with system administrator rights can create web service accounts by going to System Configuration > Security > Service Account Administration. Like user accounts, web service accounts require a unique username, password, and granular permissions. Permissions can be granted to one or more resource or method.

Go to the Service Account Administration page and add a new service account user. When you select Save, the password displays.

Important
Copy the password as it will not be shown again.

For more information, refer to the UKG Developer Hub.

Permissions to UKG Pro Core HCM Web Service Account User

Modify the Web Service User to associate the required permissions for the following UKG Pro Core HCM Web Services:

Operation	Comments
TEST CONNECTION	The service account must have the View role for the Company Configuration Integration Web Service.
ACCOUNT AGGREGATION	The service account must have View role for the Employee Export Web Service.
ACCOUNT AGGREGATION (for additional attributes)	To aggregate Job Configuration Details, Location Configuration Details, and Org level (1/2/3/4) Details, the service account must have the View role for the Company Configuration Integration Web Service. To aggregate Employment Details, User Defined Field Details, and Platform Configuration Field Details, the service account must have View role for the Personnel Integration Web Service.
PROVISIONING	The service account must have the View role for the Company Configuration Integration Web Service AND View and Add roles for the Personnel Integration Web Service.