In this article
Overview
Use this account type to connect Exact Online Snaps with Exact Online instance using Exact Online OAuth 2.0 Account.
Prerequisites
Valid Exact Online Login account (valid user name and password)
Valid client application (valid client Id and client secret)
Limitations and Known Issues
None
Account Settings
Call-back Domain: The redirect URI must be set differently in the app that is created in the endpoint: https://<SnapLogic_POD_Name>/api/1/rest/admin/oauth2callback/rest
For example: "https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest" in the screenshot below:
To create your REST OAuth2 account in SnapLogic, you must provide at least your Client ID, Client secret, OAuth2 endpoint, and OAuth2 token and click Authorize. SnapLogic sends your account details to the OAuth2 endpoint specified and populates the Access token, Refresh token, and Access token expiration fields using the details received from that endpoint.
Field names marked with an asterisk ( * ) are mandatory.
Field Name | Field Dependency | Description |
---|---|---|
Label* | String | Specify the name for the account. We recommend you to update the account name, if there is more than one account in your project. Default Value: N/A |
Client ID* | String | Specify the client ID associated with your account. You can create the client ID as advised by your application provider. An example and its meaning can be found here. Default Value: N/A |
Client secret* | String | Specify the client secret associated with your account. You can create the client secret as advised by your application provider. An example and its meaning can be found here. Default Value: N/A |
Access token | String | Auto-generated after authorization. The token that SnapLogic uses to make API requests on behalf of the user associated with the client ID. Default Value: N/A |
Refresh token | String | Auto-generated after authorization. The refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires. Default Value: N/A |
Access token expiration | Time | Auto-generated after authorization. The access token expiration value, in seconds. Default Value: Current Time + 3600 seconds |
OAuth2 Endpoint* | String | Specify the URL of the endpoint that authorizes the application. Default Value: N/A |
OAuth2 Token* | String | Specify the URL of the endpoint that retrieves the token for an authenticated account. Default Value: N/A |
Token endpoint config | Use this field set to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows. This field set comprises the following fields:
| |
Token endpoint parameter | String | Defines an optional token endpoint parameter. |
Token endpoint parameter | String | Defines an optional token endpoint parameter. |
Auth endpoint config | Use this field set to provide custom properties for the OAuth2 auth endpoint. Click the + or - icons to respectively add or remove configuration rows. This field set comprises the following fields:
| |
Auth endpoint parameter | String | Defines an optional authorization endpoint parameter. Default Value: N/A |
Auth endpoint value | String | The value associated with the optional authorization endpoint parameter defined above. Default Value: N/A |
Auto-refresh token | Check Box | Select this checkbox to refresh the token automatically using the refresh token, if the property is enabled. If this property is deselected, the token expires and is not refreshed automatically. Default Value: Deselected |
Authorize | Button | Click this button to authorize the REST OAuth2 account using the credentials provided in the Client ID, Client Secret, OAuth2 Endpoint, and OAuth2 Token fields. |
Refresh | Button | Click this button to refresh the access token using the credentials provided in the Client ID, Client Secret, OAuth2 Token, and refresh token fields. |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Account validation failed. | The Pipeline ended before the batch could complete execution due to a connection error. | Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open. |
Snap Pack History
See Also
Configuring Exact Online Account
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started