Workday REST OAuth2 Account

Overview

You can configure your accounts in SnapLogic using the Designer or Manager. Use the Workday REST OAuth2 Account type to connect the Workday REST Snap with endpoints that require OAuth2 authorization.



Prerequisites

  • Valid Client ID, Client secret, and OAuth2 Endpoint
  • Valid tenant URL

Limitations

None.

Known issues

This Snap does not support bulk operation.

Account settings

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field/Field set Description
Label*

String		 Required. Specify the name for the Workday REST account. We recommend that you update the account name if there is more than one account of the same account type in your project.

Default value: N/A

Example: Workday REST OAuth2 Account
Workday Tenant Details

Fieldset		 Use this fieldset to specify details about your Workday tenant. This field set contains the following fields:
Host

String		 Required. Specify the Host details under Workday Tenant details.

Default value: N/A

Example: wd2-services.workday.com
Tenant

String/Expression		 Required. Specify the Tenant details under the Workday Tenant details.

Default value: N/A

Example: snap
Client ID

String		 Required. Specify the client ID associated with your account. You can create the client ID as advised by your application provider. Learn more about generating a client ID.

Default value: N/A

Example: GHI789456JKL3210
Client secret

String		 The client secret associated with your account. The client secret is auto-generated on registering the API client as advised by your application provider. Learn more about generating a client secret.

Default value: N/A

Example: abcd1234efgh5678ijkl9012mnop3456
Access token

String		 Required. Auto-generated on account authorization. The access token is used to make API requests on behalf of the user associated with the client ID.

Default value: N/A

Example: 857426
Refresh token

String		 Auto-generated on account authorization. The token used to refresh the access token.

To access the API beyond the lifetime of a single access token, your application can obtain a refresh token. The application stores the refresh token for future use and automatically refreshes the access token before it expires.

Default value: N/A

Example: 857427
Access token expiration

Integer		 Auto-generated on account authorization. The number of seconds after which the access token expires.

Default value: N/A

Example: 6541
Header authenticated

Checkbox		 Select this checkbox to enable the endpoint's bearer header authentication.

Default value: Deselected
OAuth2 Endpoint

String		 Required. Specify the endpoint in this format https://impl.workday.com/<tenant_details>/authorize to authorize the application.

Default value: N/A

Example: https://impl.workday.com/snaplogic_pt2/authorize
OAuth2 Token

String		 Required. Specify the OAuth2 token in this format https://wd2-impl-service1.workday/oauth2/tenant_details/token to get the access token.

Default value: N/A

Example: https://wd2-service.workday/oauth2/snap/token
Token endpoint config

Fieldset		 Use this fieldset to define custom properties for the OAuth2 token endpoint. This endpoint returns access tokens or refresh tokens depending on the request parameters. This field set contains the following fields:
Token endpoint parameter

String		 Specify the parameter for the token endpoint.

Default value: N/A
Token endpoint parameter value

String		 Specify the value associated with the optional endpoint parameter defined above.

Default value: N/A
Auth endpoint config

Fieldset		 Use this fieldset to define custom properties for the OAuth2 authentication endpoint. This field set contains the following fields:
Authentication parameter

String		 Specify the parameter for OAuth2 authentication.

Default value: N/A

Example: redirect_uri
Authentication parameter value

String		 Specify the value associated with the optional authorization endpoint parameter defined above.

Default value: N/A
Auto-refresh token

Checkbox		 Select this checkbox to enable auto-refresh of the access token before it expires. Learn more about how the SnapLogic Platform handles token refresh failures.

During the process of Registering an API Client for generating the Workday OAuth2 credential, if you select the Enforce 60 Minute Access Token Expiry option, the OAuth2 credential generates an access token which expires in 60 minutes. If you select the Auto-refresh token checkbox, the token automatically refreshes.

  • 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, and 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. Therefore, we recommend you enable this option to avoid this error.

Default value: Deselected
Note: Click Validate after entering the required details to ensure that all fields have been filled accurately. Click Apply to save the settings.

Troubleshooting

Type Description Examples of upstream and downstream Snaps
Error 401 The Pipeline could not complete execution due to a connection error. Verify that the Refresh token field is configured to properly handle the inputs. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
Insufficient Permissions. You do not have the required permissions to access the resource. Contact your Workday Org Admin to resolve the POST permissions issue.