Versions Compared

Old Version 41

changes.mady.by.user Leena Gopal

Saved on

compared with

New Version Current

changes.mady.by.user Lakshmi Manda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel2
absoluteUrltrue

Overview

The Workday portal allows you to register the required API client based on the category and locate all the necessary information for setting up the Workday REST OAuth2 Account.

Register an API Client

  1. Log into the Workday portal with valid Workday Org admin credentials in this format: https://impl.workday.com/wday/authgwy/<your_tenant_name>/login.htmld.

  2. From the Search menu for the Workday categories, select Register API Client and click Register.

  3. Provide details for the following mandatory fields:

    1. Client Name: Specify a name for the API Client

    2. Client Grant Type: Select Authorization Code Grant.
      Note: Currently, Snap supports only Authorization Grant Code grant types.

    3. Select Enforce 60 Minutes Access Token Expiry for the Auto-refresh token to work correctly in the Workday REST OAuth2 Account.

    4. Access Token Type: Select Bearer.

    5. Redirect URL: https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/workday

    6. Scope: Select all the services you need to access from the dropdown list.

  4. Click on Done.

    Image RemovedImage Added

    Image Removedworkday-rest-client-id (1).pngImage Added

Note

  • When you enable the Enforce 60 Minute Access Token Expiry option, the generated OAuth2 credential contains the access token, which expires in 60 minutes. To refresh this token automatically, select the Auto-refresh token checkbox in the Workday REST OAuth2 Account.

  • When you disable the Enforce 60 Minute Access Token Expiry option, the generated credential contains the Access token with its Access token expiration value set as -1 in the Workday REST OAuth2 Account. This access token is valid for several hours, but the Auto-refresh token feature cannot refresh the access token in this scenario.

If you disable the Enforce 60 Minute Access Token Expiry option, you might encounter an Invalid Access Token error intermittently. Hence, we recommend you enable this option to avoid this error.

Locate the Information Required to Configure Your Snap Account

  1. After the API client is registered in the Workday portal, note down the Client ID, Client Secret, Authorization Endpoint, and Token Endpoint automatically generated to be used in the Workday REST OAuth2 Account.

  2. Click on the Authorize button in the Workday OAuth2 Account. You will be redirected to the Workday Portal. Provide valid login credentials and click on Allow.

We recommend you use the Admin login credentials (who initially created the API) for authorization. The required permissions are granted only to the admin who creates the application.

Note

The OAuth2 credentials generated in the Register API Client Admin console grants you only GET permission for Workday services and OpenAPI paths.

While registering an API client, when you encounter Insufficient permission or such permission-related errors, we recommend that you contact the Workday Org Admin to resolve the POST permission issue.

Configure Workday REST OAuth2 Account

  1. In the Workday REST Snap, specify the details to set up the Workday REST OAuth2 Account with the following details noted in the previous steps:
    - Host details
    - Tenant details
    - Client ID
    - Client secret
    - OAuth2 Endpoint
    - OAuth2 Token

    Image RemovedEdit_oauth_account (1).pngImage Added

  2. Click Click the Authorize button, and after successful authorization, click the Apply button.

...