Versions Compared

Old Version 13

changes.mady.by.user Shilpa

Saved on

compared with

New Version 14

changes.mady.by.user Shilpa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use this account type to connect REST Snaps with data sources that use OAuth2 SSL accounts. 

Prerequisites

None.

Limitations and Known Issues

None.

Account Settings


ParameterData TypeDescriptionDefault ValueExample 
LabelStringRequired. 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/AREST OAuth2 Account
Client IDString

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/A88a731111-07k1-4714-xz5a-de111aaa9a5e
Client secretString

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/Az111aaa1-aa11-11aa-1a11-0d1111a1111
Access tokenStringAuto-generated after authorization. The token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.N/AN/A
Refresh tokenString

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/AN/A
Access token expirationTimeAuto-generated after authorization. The access token expiration value, in seconds.Current Time + 3600 seconds10000s

Header authenticated

Check BoxSelect this check box to indicate that the endpoint uses bearer header authentication.DeselectedN/A

OAuth2 Endpoint

StringRequired. The URL of the endpoint that authorizes the application. N/Ahttps://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 account.access_token explicitly. The property must be marked as an expression. An example URL for LinkedIn is: "https://api.linkedin.com/v1/people/~?oauth2_access_token=" + account.access_token.

N/Ahttps://api.adp.com/auth/oauth/v2/token
Grant Type

Select the method of authorization.

  • Authorization Code: The user is authenticated using credentials (username and password), which return to the client through a redirect URL. The application then receives the authorization code from the URL and uses it to request an access token.
  • Client Credentials: Obtains an access token to the client ID and client secret through the token endpoint URL.
Authorization Code
client_credentials
KeyStoreStringThe location of the key store file. It can be in SLDB or at any other unauthenticated endpoint.N/Ashared/client_keystore.jks
TrustStoreStringThe location of the trust store file. It can be in SLDB or at any other unauthenticated endpoint.N/Ashared/client_truststore.jks
Key/Trust store passwordStringPassword for the key/trust store. It is used for both, if both are defined.N/AN/A
Key aliasStringThe alias of the key that you want to use with this account.N/AN/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
  • Token endpoint parameter value


Token endpoint parameter

StringDefines an optional token endpoint parameter.N/A
Token endpoint parameter valueStringThe 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
  • Auth endpoint value


Auth endpoint parameterStringDefines an optional authorization endpoint parameter.N/A
Auth endpoint valueStringThe value associated with the optional authorization endpoint parameter defined above.N/A
Auto-refresh tokenCheckboxSelect 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.DeselectedN/A
AuthorizeButtonClick 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/AN/A
Send Client Credentials Data as Basic Auth HeaderCheckboxSelect this checkbox when you want to send the client information as a header to the OAuth endpoint.DeselectedN/A


Troubleshooting

...