Generate and Access App Keys

Requests against the UKG API require a valid application key passed in the HTTP appkey header. This key allows you to track your API usage per application.

The app key must be generated by an employee with the appropriate Developer Admin permissions. Refer to the Configure Developer Portal access topic in the Developer Portal for more information.

To generate and access app keys:

  • Log in and navigate to My Apps
  • Generate a key
  • Update the name associated with a key
  • Access and use app keys

To log in to the suite UI and navigate to My Apps:

  1. Log in as a manager with full Developer Portal access permissions.

  2. Open the Main Menu, select Administration and Application Setup. Expand Common Setup and select My Apps.

  3. A list of current application names and associated statuses is displayed.

To generate an app key:

To generate an app key:

  1. Log in and navigate to My Apps.

  2. From My Apps, select Add. Create App Key appears.

  3. Enter a name for your application in the Name field.

    Note: Remember the name you select for this application. This display name can be changed later.

  4. Select Save.

  5. A Success confirmation appears. Under My Apps, select the name of the application you created in the previous step and select Details.

  6. The Keys menu is automatically expanded and the App Key field displays your app key.

    Note: Do not share your app key. This key cannot be changed.

To update the name associated with an app key:

  1. Log in and navigate to My Apps.

  2. Select the name of the application and select Edit. Edit <<app name>> appears.

  3. Enter a new name for your application in the Name field.

    Note: Remember the name you select for this application. This display name can be changed later.

  4. Select the radio button next to either Save changes everywhere that the named entity is used or Save as a new named entity and select Save.

    Note: If you select Save as a new named entity, this generates a new app key associated with the new name you entered. The existing app key remains associated with the original entity's name.

  5. A Success confirmation appears.

    Note: Do not share the app key.

Developers and Developer Administrators can both view app keys and make API calls using those app keys. Refer to the Configure Developer Portal access help topic in the Developer Portal online help for more information.

To view the app key associated with an application:

  1. Log in and navigate to My Apps.

  2. Select the name of the application and select Details.

  3. The Keys menu is automatically expanded and the App Key field displays your app key.

Use app keys to generate tokens by following the steps in the Authentication and Security help topic or use an app key to Make an API call help topic in the Developer Portal online help.