Label

String

Required. Enter a unique and meaningful name for your account.

Default Value: N/A
Example: REST OAuth2 Account

Client ID

String

Required. 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.

Default Value: N/A
Example: 88a731111-07k1-4714-xz5a-de111aaa9a5e

Client secret

String

Required. 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.

Default Value: N/A
Example: z111aaa1-aa11-11aa-1a11-0d1111a1111

Access token

String

Auto-generated after authorization. Enter the token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.

Default Value: N/A
Example: N/A

Refresh token

String

Auto-generated after authorization. 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.

Default Value: N/A
Example: N/A

Access token expiration

Time

Auto-generated after authorization. Enter the access token expiration value, in seconds.

Default Value: Current Time + 3600 seconds
Example: 10000s

Header authenticated

Check Box

Select this checkbox to indicate that the endpoint uses bearer header authentication.

Default Value: Deselected

OAuth2 Endpoint

String

Required. Enter the URL of the endpoint that authorizes the application. 

Default Value: N/A
Example: https://api.adp.com/auth/oauth/v2/authorize

OAuth2 Token

String

Required. 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 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.

Default Value: N/A
Example: https://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.

Default Value: Authorization Code
Example: Client Credentials

KeyStore

String

Enter the location of the key store file. It can be in SLDB or at any other unauthenticated endpoint.

Default Value: N/A
Example: shared/client_keystore.jks

TrustStore

String

Enter the location of the trust store file. It can be in SLDB or at any other unauthenticated endpoint.

Default Value: N/A
Example: shared/client_truststore.jks

Key/Trust store password

String

Enter the password for the key/trust store. It is used for both, if both are defined.

Default Value: N/A
Example: N/A

Key alias

String

Enter the alias of the key that you want to use with this account.

Default Value: N/A
Example: 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

• Token endpoint parameter value

Token endpoint parameter

String

Define an optional token endpoint parameter.

Default Value: N/A
Example: N/A

Token endpoint parameter value

String

Enter the value associated with the optional endpoint parameter defined above.

Default Value: N/A
Example: 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 field set comprises the following fields:

• Auth endpoint parameter

• Auth endpoint value

Auth endpoint parameter

String

Define an optional authorization endpoint parameter.

Default Value: N/A
Example: N/A

Auth endpoint value

String

The value associated with the optional authorization endpoint parameter defined above.

Default Value: N/A
Example: N/A

Auto-refresh token

Checkbox

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.

Default 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

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:

• Label

• Client ID

• Client Secret

• OAuth2 Endpoint

• OAuth2 Token

Insert valid details into the following fields and click Authorize.

• Label

• Client ID

• Client Secret

• OAuth2 Endpoint

• OAuth2 Token

You attempted to authorize your account, but authorization failed. Thus, the following fields are empty:

• Access token

• Refresh token

• Access expiration token

You still click Apply.