In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
Use You can use this account type to connect REST Snaps with datasources data sources that use OAuth2 SSL accounts.
Prerequisites
None.
Limitations and Known Issues
None.
Account Settings
ParameterField Name | Data Field Type | Description | Default Value | Example |
---|---|---|---|---|
Label | String | Required. TheEnter a unique and meaningful name for theyour account. We recommend that you update the account name if there is more than one account of the same account type in your project.NDefault Value: N/A | ||
Client ID | String | Required. The Enter 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. | NDefault Value: N/A | |
Client secret | String | Required. The Enter 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. NDefault Value: N/A | ||
Access token | String | Auto-generated after authorization. TheEnter the token that SnapLogic uses to make API requests on behalf of the user associated with the client ID. NDefault Value: N/A Example: N/A | ||
Refresh token | String | Auto-generated after authorization. The Enter the refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires. NDefault Value: N/A Example: N/A | ||
Access token expiration | Time | Auto-generated after authorization. TheEnter the access token expiration value, in seconds. Default Value: Current Time + 3600 seconds | ||
Header authenticated | Check Box | Select this check boxcheckbox to indicate that the endpoint uses bearer header authentication. | Deselected | N/A Default Value: Deselected |
OAuth2 Endpoint | String | Required. TheEnter the URL of the endpoint that authorizes the application. NDefault Value: N/A | ||
OAuth2 Token | String | Required. The Enter the URL of the endpoint that retrieves the token for an authenticated account. If you are using a REST OAuth2 Account, access the account token through Default Value: N/A | ||
Grant Type | Select the method of authorization.
Default Value: Authorization Code | client_credentialsExample: Client Credentials | ||
KeyStore | String | The Enter the location of the key store file. It can be in SLDB or at any other unauthenticated endpoint. NDefault Value: N/A | ||
TrustStore | String | The Enter the location of the trust store file. It can be in SLDB or at any other unauthenticated endpoint. NDefault Value: N/A | ||
Key/Trust store password | String | Password Enter the password for the key/trust store. It is used for both, if both are defined. NDefault Value: N/A Example: N/A | ||
Key alias | String | The Enter the alias of the key that you want to use with this account. NDefault Value: N/A Example: N/A | ||
Token endpoint config | Use this fieldset field set to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows. This fieldset field set comprises the following fields:
| |||
Token endpoint parameter | String | Defines Define an optional token endpoint parameter. NDefault Value: N/A | ||
Token endpoint parameter value | String | The value Enter the value associated with the optional endpoint parameter defined above. NDefault Value: N/A | ||
Auth endpoint config | Use this fieldset to provide custom properties for the OAuth2 auth endpoint. Click the + or - icons to respectively add or remove configuration rows. This fieldset field set comprises the following fields:
| |||
Auth endpoint parameter | String | Defines Define an optional authorization endpoint parameter. Default Value: N/A | ||
Auth endpoint value | String | The value associated with the optional authorization endpoint parameter defined above. NDefault Value: N/A | ||
Auto-refresh token | Check BoxCheckbox | Select this check boxcheckbox 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. | Deselected | N/A 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. NDefault Value: N/A Example: N/A | ||
Send Client Data as Basic Auth Header | Checkbox | Select this checkbox when you want to send the client information as a header to the OAuth endpoint. Default Value: Deselected |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
One or more required field is blank | You click Authorize in the account dialog window, but one or more of the following fields is blank:
| Insert valid details into the following fields and click Authorize.
|
You attempted to authorize your account, but authorization failed. Thus, the following fields are empty:
You still click Apply. |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...
See Also
...