In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
Use this account type to connect REST Snaps with datasources that use OAuth2 SSL accounts.
Prerequisites
None.
Limitations and Known Issues
None.
Account Settings
Parameter | Data Type | Description | Default Value | Example |
---|---|---|---|---|
Label | String | Required. The name for the account. We recommend that you update the account name if there is more than one account of the same account type in your project. | N/A | REST OAuth2 Account |
Client ID | String | Required. 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. | N/A | 88a731111-07k1-4714-xz5a-de111aaa9a5e |
Client secret | String | Required. 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. | N/A | z111aaa1-aa11-11aa-1a11-0d1111a1111 |
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. | N/A | 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. | N/A | N/A |
Access token expiration | Time | Auto-generated after authorization. The access token expiration value, in seconds. | Current Time + 3600 seconds | 10000s |
Header authenticated | Check Box | Select this check box to indicate that the endpoint uses bearer header authentication. | Deselected | N/A |
OAuth2 Endpoint | String | Required. The URL of the endpoint that authorizes the application. | N/A | https://api.adp.com/auth/oauth/v2/authorize |
OAuth2 Token | String | Required. 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 | N/A | https://api.adp.com/auth/oauth/v2/token |
Grant Type | Select the method of authorization.
| Authorization Code | client_credentials | |
KeyStore | String | The location of the key store file. It can be in SLDB or at any other unauthenticated endpoint. | N/A | shared/client_keystore.jks |
TrustStore | String | The location of the trust store file. It can be in SLDB or at any other unauthenticated endpoint. | N/A | shared/client_truststore.jks |
Key/Trust store password | String | Password for the key/trust store. It is used for both, if both are defined. | N/A | N/A |
Key alias | String | The alias of the key that you want to use with this account. | N/A | N/A |
Token endpoint config | Use this fieldset to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows. This fieldset comprises the following fields:
| |||
Token endpoint parameter | String | Defines an optional token endpoint parameter. | N/A | |
Token endpoint parameter value | String | The value associated with the optional endpoint parameter defined above. | 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 comprises the following fields:
| |||
Auth endpoint parameter | String | Defines an optional authorization endpoint parameter. | N/A | |
Auth endpoint value | String | The value associated with the optional authorization endpoint parameter defined above. | N/A | |
Auto-refresh token | Check Box | Select this check box 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 |
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. | N/A | N/A |
Send Client Credentials as Basic Auth Header | Check Box | Select this check box when you want to send the client information as a header to the OAuth endpoint. | Deselected | N/A |
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. |
...