Skip to end of banner
Go to start of banner

Salesforce OAuth2 Account

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 32 Next »

On this page

Overview

Use this account type to access the following Snaps:

Prerequisites

You should have:

  • 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

Parameter Name
Data Type
Description
Default Value
Example 
LabelStringRequired. The name for the account. Preferably update the name if your project has more than one account of the same type.N/ASalesforceOauth2Account
Instance URLString

Required. Instance URL to be used to access Salesforce.com

N/Ahttps://ap15.salesforce.com
Client IDString

Required. The identification for the client that you obtain from the API Console.

N/A

abcd12345xyz567

Client secretString

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.

N/AN/A
Access tokenString

Required. 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.

N/AN/A
Refresh tokenString

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.

N/AN/A
Access token expirationIntegerThe expiry value for the access token. It represents the number of refresh tokens per user account per client.

N/A

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.

-1

Header authenticatedN/ASelect to enable the property if the endpoint uses bearer header authentication.N/AN/A
OAuth2 EndpointStringRequired. The endpoint to authorize the application.N/A
  • For the production environment: 
    https://login.salesforce.com/services/oauth2/authorize
  • For sandbox:
    https://test.salesforce.com/services/oauth2/authorize
OAuth2 TokenStringRequired. The endpoint to get the access token. N/A
  • For the production environment
    https://login.salesforce.com/services/oauth2/token
  • For sandbox:
    https://test.salesforce.com/services/oauth2/token
Token endpoint configN/ACustom properties for the OAuth2 token endpoint.N/AN/A
Token endpoint parameterStringParameter for the token endpoint.N/Aredirect_uri
Token endpoint parameter valueIntegerValue for the token endpoint parameter.N/Ahttps://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest
Auth endpoint configN/ACustom properties for the OAuth2 authentication endpoint.N/AN/A
Authentication parameterStringParameter for OAuth2 authentication.N/Aredirect_uri
Authentication parameter valueIntegerValue for the OAuth2 authentication parameter.N/Ahttps://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest
Auto-refresh tokenCheck boxSelect to enable auto-refresh of the access token before it expires.N/AN/A

Example

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

  • No labels