In this article

Overview

You can use this account type to connect API Suite Snaps with data sources that use SSL OAuth2 accounts.

Prerequisites

Valid Client ID and Client secret.

Limitations and Known Issues

None.

Account Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.

Field Name		Field Type	Description
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. You must select the Header Authenticated checkbox in the account for the successful execution of the pipeline. You might be able to authorize the account successfully with or without enabling that checkbox. However, the pipeline fails if the checkbox is deselected in the account.
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.

Troubleshooting

Error

Reason

Resolution

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.

Snap Pack History

API Suite Snap Pack

Release	Snap Pack Version	Date	Type	Updates
May 2024	437patches26491	23 May 2024	Latest	Fixed an issue with the GraphQL Client Snap that displayed an error when passing the `Float` data type query variables to the endpoint.
May 2024	main26341	08 May 2024	Stable	Updated and certified against the current SnapLogic Platform release.
February 2024	436patches25508	18 Mar 2024	Latest	Enhanced the HTTP Client Snap to optimize the memory usage by accumulating the `Request History` objects only when you select the Enable debug checkbox. Now, the Snap displays debug information and lint warnings only (in both Error view and Output view) when you select the Enable debug checkbox.
February 2024	463patches25211	26 Feb 2024	Latest	Enhanced the GraphQL Client Snap to include detailed stack trace, error message, and reason within the Snap error view output.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	435patches25047	02 Feb 2024	Latest	Fixed an issue that caused the HTTP Client Snap to fail when the Basic Authentication account password contained special characters.
November 2023	435patches24708	23 Jan 2024	Latest	Added support for the SSL OAuth2 Account. The HTTP Client and GraphQL Client Snaps now support accessing usernames and passwords from the Basic Authentication account. The HTTP Client Snap also has this capability for the Digest Authentication, NTLM, SSL, and Google Service accounts. Enhanced the API Suite OAuth2 Account with the Send client data as Basic Auth header checkbox to pass the client data as a part of the Basic Authentication header when generating a token.
November 2023	435patches24208	11 Dec 2023	Latest	Fixed an issue with the HTTP Client Snap that caused incorrect parsing of the `boundary` parameter by some REST endpoints. If you need to specify a character set, enter it in the individual parts of the request, as the `charset` parameter has been removed from the multipart content-type.
November 2023	435patches23943	21 Nov 2023	Latest	Fixed an issue with the GraphQL Client Snap that displayed a null pointer exception when the Header authenticated checkbox in the OAuth2 Account is deselected. The Snap now passes the credentials appropriately using URL parameters when the Header authenticated field is deselected.
November 2023	main23721	08 Nov 2023	Stable	Added the Google Service Account to the HTTP Client Snap, which enables you to connect to various Google Cloud endpoints such as Analytics 4 and Compute Engine.
August 2023	434patches23079	05 Oct 2023	Latest	Fixed an issue with the SnapLogic SSL Account for the HTTP Client Snap where a blank keystore or truststore URL caused an error during account configuration.
August 2023	434patches22631	24 Aug 2023	Latest	Fixed an issue with the HTTP Client Snap that displayed incorrect cookie information, with a null value in the cookies when you have duplicate cookies in the header. The Snap now displays the cookie information correctly.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	433patches22065	24 Jul 2023	Latest	Fixed an issue with the GraphQL Client Snap that caused an error even when the variable value was defined in the previous Snap.
May 2023	433patches21959	20 Jul 2023	Latest	Fixed an issue with the HTTP Client Snap that caused an intermittent connectivity issue, which resulted in a `404 error` .
May 2023	433patches21860	12 Jul 2023	Latest	Fixed an issue with the HTTP Client Snap where the Snap now conceals the additional authentication headers in the debug information for Secured Headers Account.
May 2023	433patches21346	05 Jun 2023	Latest	Fixed an issue with the HTTP Client Snap where the validation of the SSL Account for a specified Keystore or Truststore value failed despite providing the correct password.
May 2023	433patches21307	31 May 2023	Latest	Fixed an issue with the HTTP Client Snap that caused pagination to fail when the next Snap in the pipeline could modify the input document (for example, the Mapper Snap). Behavior Change: With the `433patches21307`, pagination evaluation occurs before sending the output to the output view. Therefore, if `snap.out.totalCount` is part of the Has next or any other pagination properties, the Snap will not include the count in the output corresponding to the request that produced the output document.
May 2023	433patches21140	18 May 2023	Latest	Fixed an issue affecting the HTTP Client Snap, which caused it to hang for an extended period when the user-agent contained the term `java`. The HTTP Client Snap is enhanced with the Prevent URL encoding checkbox. This checkbox enables you to control whether the Snap should automatically encode the URL or prevent the URL encoding based on your preference.
May 2023	main21015	10 May 2023	Stable	Introduced the GraphQL Client Snap, which enables you to query a GraphQL endpoint and retrieve data. This Snap features a built-in query builder to help you efficiently build queries.
February 2023	432patches20818	27 Apr 2023	Latest	Fixed an issue with the HTTP Client Snap that caused encoding of spaces in the query portion of an URL with a plus sign (+) instead of percent-encoding (%). This fix changes the default behavior to percent-encoding through the Use form encoding for spaces checkbox, which is deselected by default. Select this checkbox to enable the Snap to encode any space characters in query parameters using the plus sign (+). Updated the HTTP Client Snap to stop sending unnecessary headers in GET requests that do not have an entity defined.
February 2023	432patches20054	09 Mar 2023	Latest	For Snaps using AWS Signature V4 accounts, DNS canonical names are now supported for S3 buckets.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	431patches19006	02 Dec 2022	Latest	The HTTP Client Snap does not fail when making a PATCH request containing an empty response body and location in the Headers. The Snap checks the entity length if the response entity is empty and skips the data conversion.
November 2022	main18944	10 Nov 2022	Stable	The HTTP Client Snap now accepts the default value `/` for the `Accept` header, which communicates to the server that the Snap can handle all forms of response content types.
October 2022	430patches18454	13 Oct 2022	Latest and Stable	Introduced the API Suite Snap Pack that contains the HTTP Client Snap. This Snap unifies all supported HTTP methods: GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, and PATCH that you can execute on a REST API service endpoint.

SSL OAuth2 Account