In Memory OAuth2 Account

Overview

You can use this account type to connect API Suite Snaps with data sources that support Client credentials OAuth2 authentication. This account should be used when the access tokens provided by the Client Credentials grant type OAuth2 Authentication are short-lived (less than 30 minutes in time), as the account stores them in memory for reuse.

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: In-memory OAuth2 Account
Client ID

String

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

Default value: N/A

Example: p364e45x-953x-460p-9pb0-934xep16p693
Client secret

String

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

Default value: N/A

Example: ABC123def456GHI789_jklMNO
Send client data as basic auth header

Checkbox

 Select this checkbox to send the client information as a header to the OAuth endpoint.

Default status: Deselected
OAuth2 token endpoint

String

 Required. Specify the URL of the endpoint (in the following format) that retrieves the token for an authenticated account. https://<endpoint name>.endpoint.com/oauth_token
Note: When the Snap encounters 401 or 403 errors, this account generates a new token and updates the cache.

Default value: N/A

Example: https://snaplogic-demo.xyzcloud.com/oauth2/token
Grant type By default, this account uses Client Credentials Grant Type to obtain an access token using the Client ID and Client secret through the token endpoint URL.

Default value: client_credentials

Example: client_credentials
Token endpoint config Use this field set to provide custom properties for the OAuth2 token endpoint.
Token endpoint parameter

String

 Specify additional token endpoint parameters.

Default value: N/A

Example: Scope
Token endpoint parameter value

String

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

Default value: N/A

Example: core.accounting.read core.approval.read
Authorize

Button

 After you configure the account settings, click the Authorize button to authenticate your account.