Label*

Default Value: N/A
Example: OAuth2 SSL Account

String

Specify a unique and meaningful name for your account.

Client ID*

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

String

Specify the client ID associated with your account. You can create the client ID as advised by your application provider.

Client secret

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

String

Specify the client secret associated with your account. You can create the client secret as advised by your application provider.

Access token

Default Value: N/A
Example: eyJ0eXAiOiJhdCtKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzd

String

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.

Refresh token

Default Value: N/A
Example: eyF0eXAiOiJhdCtKV1QiLCJhbGciOiJSUzUxMiJ9HkyJzd

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 the token expires.

Access token expiration

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

String

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

Header authenticated

Default Value: Deselected

Checkbox

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

OAuth2 authorization endpoint*

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

String

Specify the authorization endpoint that authorizes the application. 

OAuth2 token endpoint*

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

String

Specify the URL of the endpoint that retrieves the token for an authenticated account.

Grant type

Default Value: Authorization Code
Example: Client Credentials

Dropdown List

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 for the client ID and client secret through the token endpoint URL.

• Password: Obtains an access token using your log-in credentials (username and password). When selected, this field populates the following fields:

  • Username: Specify the username of the account type.

  • Password: Specify the password of the account type.

KeyStore

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

String

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

TrustStore

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

String

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

Key/Trust store password

Default Value: N/A

String

Specify the password for the key/trust store. It is used for both Key and Trust stores, if both are defined.

Key alias

Default Value: N/A
Example: -keysize 2048

String

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

Token endpoint config

Use this field set to provide custom properties for the OAuth2 token endpoint.

Token endpoint parameter

String

Specify an optional token endpoint parameter.

Token endpoint parameter value

String

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

Auth endpoint config

Use this field set to provide custom properties for the OAuth2 auth endpoint.

Auth endpoint parameter

String

Define an optional authorization endpoint parameter.

Auth endpoint value

String

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

Auto-refresh token

Default Value: Deselected

Checkbox

Select this checkbox to refresh the token automatically using the refresh token. When you deselect this checkbox, the token expires and is not refreshed automatically.

Authorize

Button

Click this button to authorize the REST OAuth2 account using the credentials provided in the Client ID, Client secret, OAuth2 authorization endpoint, and OAuth2 token endpoint fields.

One or more required fields are 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

Failure: Failed to execute the request, or the endpoint responded an error

Got response 401 - Unauthorized from the endpoint.

Refer to the error document in the error view for more information.