SSL OAuth2 Account

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.

Account settings

Legend:

Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
Upload : Uploads files. Learn more.

Learn more about the icons in the Snap settings dialog.


Field / Field set	Type	Description
Label	String	Required. Specify a unique label for the account. Default value: N/A Example: OAuth2 SSL Account
Client ID	String	Required. Specify the client ID associated with your account. You can create the client ID as advised by your application provider. Default value: N/A Example: 88a731111-07k1-4714-xz5a-de111abc9a5e
Client secret	String	Specify the OAuth Client secret associated with your account. Specify the client secret associated with your account. You can create the client secret as advised by your application provider. Default value: N/A Example: z111aaa1-aa11-11aa-1a11-0d1111a1111
Access token	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. Default value: N/A Example: eyJ0eXAiOiJhdCtKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzd
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 the token expires. Default value: N/A Example: eyF0eXAiOiJhdCtKV1QiLCJhbGciOiJSUzUxMiJ9HkyJzd
Access token expiration	String	Auto-generated after authorization. The access token expiration value, in seconds. Default value: Current Time + 3600 seconds Example: 10000s
Header authenticated	Checkbox	Select this checkbox to indicate that the endpoint uses bearer header authentication. Note: 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. Default status: Deselected
OAuth2 authorization endpoint	String	Required. Specify the authorization endpoint that authorizes the application. Default value: N/A Example:
OAuth2 token endpoint	String	Required. Specify the URL of the endpoint that retrieves the token for an authenticated account. Default value: N/A Example:
Grant type	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 login 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. Default value: Authorization Code Example: Client Credentials
KeyStore	String/Expression	Specify 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/Expression	Specify 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	Specify the password for the key/trust store. It is used for both Key and Trust stores, if both are defined. Default value: N/A
Key alias	String	Specify the alias of the key that you want to use with this account. Default value: N/A Example: -keysize 2048
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	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. Default status: Deselected
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.
Send client data as Basic Auth header	Checkbox	Select this checkbox to pass the client data as part of the Basic Auth header when you generate a token. Default status: Deselected

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.