Salesforce OAuth2 Account

On this page


Overview

Use this account type to access the following Snaps:

Prerequisites

  • A Salesforce account.

  • An OAuth-connected App in Salesforce with Redirect URL (also known as call-back domain).

    The redirect URL must be set differently:

    https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/salesforce

Limitations

None.

Troubleshooting

None.

Account Settings

Field
Field Type
Description
Label*String

Specify the name for the account. Preferably update the name if your project has more than one account of the same type.

Default Value: N/A
ExampleSalesforceOauth2Account

Instance URL*String

Specify the instance URL to be used to access Salesforce.com

Default Value: N/A
Examplehttps://ap15.salesforce.com

Client ID*String

Specify the identification for the client that you obtain from the API Console.

Default Value: N/A
Exampleabcd12345xyz567

Client secretString

Specify the value for user authentication that you obtain from the API Console. Client secret is not needed for clients registered as Android, iOS, or Chrome applications.

Default Value: N/A
Example: N/A

Access token*String

Specify the access token for the application, which you retrieve when setting up the account for the endpoint. 

Access tokens have limited lifetimes; you must get a new access token after it expires.

Default Value: N/A
Example: N/A

Refresh tokenString

Specify the refresh token for the application, which you retrieve when setting up the account for the endpoint.

To access the API beyond the lifetime of a single access token, your application can obtain a refresh token. The application stores the refresh token for future use and automatically refreshes the access token before it expires.

Default Value: N/A
Example: N/A

Access token expirationInteger

Specify the expiry value for the access token. It represents the number of refresh tokens per user account per client.

If there is no date of expiration, -1 is the default value. In such cases, the access token is refreshed on a regular interval, say every hour.

Default Value: N/A
Example-1

Header authenticatedCheckbox

Select this checkbox to enable the endpoint's bearer header authentication.

Default Value: Deselected
Example: N/A

OAuth2 Endpoint*String

Specify the endpoint to authorize the application.

Default Value: N/A
Example:

OAuth2 Token*String

Specify the endpoint to get the access token. 

Default Value: N/A
Example:

Token endpoint configUse this field set to define custom properties for the OAuth2 token endpoint.

Token endpoint parameterString

Specify the parameter for the token endpoint.

Default Value: N/A
Exampleredirect_uri

Token endpoint parameter valueInteger

Specify the value for the token endpoint parameter.

Default Value: N/A
Examplehttps://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest

Auth endpoint configUse this field set to define custom properties for the OAuth2 authentication endpoint.


Authentication parameterString

Specify the parameter for OAuth2 authentication.

Default Value: N/A
Exampleredirect_uri

Authentication parameter valueInteger

Specify the value for the OAuth2 authentication parameter.

Default Value: N/A
Examplehttps://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest

Auto-refresh tokenCheckbox

Select this checkbox to enable auto-refresh of the access token before it expires.

Default Value: Deselected 

Example

For information about how to use this account type, see Salesforce Bulk Create.