Workday REST OAuth2 Account
In this article
Overview
Use the Workday RST 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
Â
Asterisk (*): Indicates a mandatory field.
Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value:Â N/A | String | 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. Â | |
Workday Tenant Details | Â | ||
Host* Default Value:Â N/A | String | Specify the Host details under Workday Tenant details. Â | |
Tenant* Default Value:Â N/A | String/Expression | Â Specify the Tenant details under the Workday Tenant details. | |
Client ID* Default Value: N/A | Â String | 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. | |
Client secret Default Value: N/A |  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.  | |
Access token* Default Value: N/A | String | Auto-generated on account authorization. The access token is used to make API requests on behalf of the user associated with the client ID. | |
Refresh token Default Value: N/A | 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. | |
Access token expiration Default Value: N/A | Integer | Auto-generated on account authorization. The number of seconds after which the access token expires. | |
Header authenticated Default Value: Deselected | Checkbox | Select this checkbox to enable the endpoint's bearer header authentication. | |
OAuth2 Endpoint* Default Value: N/A | String | Specify the endpoint in this format  | |
OAuth2 Token* Default Value: N/A  | String | Specify the OAuth2 token in this format  | |
Token endpoint config | Use this field set to define custom properties for the OAuth2 token endpoint. This endpoint returns access tokens or refresh tokens depending on the request parameters. | ||
Token endpoint parameter Default Value: N/A | String | Specify the parameter for the token endpoint. | |
Token endpoint parameter value Default Value: N/A | String | Specify the value associated with the optional endpoint parameter defined above. | |
Auth endpoint config | Use this field set to define custom properties for the OAuth2 authentication endpoint. | ||
 | Authentication parameter Default Value: N/A | String | Specify the parameter for OAuth2 authentication.  |
Authentication parameter value Default Value: N/A | String | Specify the value associated with the optional authorization endpoint parameter defined above. | |
Auto-refresh token Default Value: Deselected | Checkbox | Select this checkbox to enable auto-refresh of the access token before it expires. 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.
If you disable the Enforce 60 Minute Access Token Expiry option, you might encounter an |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
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. |
Snap Pack History
Related Content
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.