Purpose

Specifies the refresh token used to either request a new access token or renew an expired access token. When the refresh token is specified, the access token generated at connection is used to authenticate to a Salesforce instance when OAuth 2.0 is enabled (AuthenticationMethod=oauth2.0).

Refer to the Salesforce documentation to know how to obtain a refresh token.

Valid Values

string

where:

string
is the refresh token you have obtained from Salesforce.

Notes

  • If a value for the AccessToken property is not specified, the driver uses the value of the RefreshToken property to make a connection.
  • If both AccessToken and RefreshToken values are not specified, the driver cannot make a successful connection.
  • If both AccessToken and RefreshToken values are specified, the driver ignores the AccessToken value and uses the RefreshToken value to generate a new AccessToken value.

Data Source Method

setRefreshToken

Default

None

Data Type

String

See also

Configuring OAuth 2.0 authentication

AuthenticationMethod

AccessToken