Anaplan OAuth2 Account
Overview
You can use this account type to connect Anaplan Snaps with data sources that use the Anaplan OAuth2 Account. This account supports the Authorization Code grant type. Learn more about Anaplan's Authorization Code Grant API Flow.
Prerequisites
Create an OAuth2 client in Anaplan.
Limitations and Known Issues
None.
Account Settings
-
Suggestion icon (
):
Indicates a list that is dynamically populated based on the configuration.
-
Expression icon (
):
Indicates whether 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 / Field Set | Type | Description |
|---|---|---|
| Label | String | Required. Specify a unique label for the account. |
| Anaplan hostname | String/Expression |
Required. Specify the hostname (URL) to access your Anaplan workspace in the following format: https://<apiname>.anaplan.com Default value: N/A Example: https://model123.anaplan.com |
| 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 on how to enable the client ID and secret. Default value: N/A Example: YdxBzw7Lmrn43T28vH2wR4wvQ6XYcw46 |
| Client secret | String |
Specify the client secret associated with your account. You can create the client secret as advised by your application provider. Learn more on how to enable the client ID and secret. Default value: N/A Example: 1912308468823890 |
| Access token | N/A |
Auto-generated after authorization. SnapLogic® uses this token to make API requests on behalf of the user associated with the client ID. The retrieval of the access token is done when setting up the account for the endpoint. The resulting access token obtained from the OAuth2.0 flow is stored in this field. Default value: N/A Example: eyJ0eXAiOiJhdCtKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzd |
| Refresh token | N/A |
Auto-generated after authorization. After the OAuth2 flow is executed in the endpoint, the resulting refresh token is stored in this field. If the refresh token is stored, the access token can be refreshed automatically before the token expires. Note:
By default, the expiration time of the refresh token is set to 43,000 seconds (12 hours).
After this predefined time has passed, the refresh token becomes invalid, and you have to manually re-authenticate.
Default value: N/A Example: eyF0eXAiOiJhdCtKV1QiLCJhbGciOiJSUzUxMiJ9HkyJzd |
| Access token expiration | N/A |
Auto-generated after authorization. The time until which the access token is active. Default value: N/A Example: 1702421542 |
| OAuth2 authorization endpoint | String |
Required. Specify the authorization endpoint to authorize the account. Default value: https://xyz.app.anaplan.com/auth/authorize Example: https://api.mycompany.com/auth/oauth/v2/authorize |
| OAuth2 token endpoint | String |
Required. Specify the token endpoint to get the access token. Default value: https://xyz.app.anaplan.com/oauth/token Example: https://api.mycompany.com/auth/oauth/v2/token |
| Token endpoint config | Use this field set to define custom properties for the OAuth2 token endpoint. | |
| Token endpoint parameter | String |
Specify an optional token endpoint parameter. Default value: N/A Example: redirect_uri |
| Token endpoint parameter value | String |
Specify an optional token endpoint parameter value. Default value: N/A Example: https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/anaplan |
| Authorization endpoint config | Use this field set to provide custom properties for the OAuth2 authentication endpoint. | |
| Authentication parameter | String |
Specify an optional authentication parameter. Default value: N/A Example: redirect_uri |
| Authentication parameter value | String |
Specify an optional authentication parameter value. Default value: N/A Example: https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/anaplan |
| Auto-refresh token | Checkbox |
Select this checkbox to refresh the token automatically. Otherwise, the token might expire and will not be automatically refreshed. Default status: Deselected |
Troubleshooting
Anaplan API Error
Connection Error